From e9345b3a298e04df09f0c99c313fef0b5ecb1a78 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Tue, 11 Sep 2018 23:49:27 +0000 Subject: [PATCH] Deploy website Deploy website version based on 4a2b7cf614b9c766454f8d27a6f4b4b04aadee91 --- docs/zh-CN/1.0.11/api-pages.html | 179 ----------- docs/zh-CN/1.0.11/api-pages/index.html | 179 ----------- docs/zh-CN/1.0.11/blog.html | 133 -------- docs/zh-CN/1.0.11/blog/index.html | 133 -------- docs/zh-CN/1.0.11/commands.html | 143 --------- docs/zh-CN/1.0.11/commands/index.html | 143 --------- docs/zh-CN/1.0.11/custom-pages.html | 115 ------- docs/zh-CN/1.0.11/custom-pages/index.html | 115 ------- docs/zh-CN/1.0.11/doc-markdown.html | 176 ----------- docs/zh-CN/1.0.11/doc-markdown/index.html | 176 ----------- docs/zh-CN/1.0.11/installation.html | 114 ------- docs/zh-CN/1.0.11/installation/index.html | 114 ------- docs/zh-CN/1.0.11/navigation.html | 191 ------------ docs/zh-CN/1.0.11/navigation/index.html | 191 ------------ docs/zh-CN/1.0.11/publishing.html | 189 ------------ docs/zh-CN/1.0.11/publishing/index.html | 189 ------------ docs/zh-CN/1.0.11/search.html | 110 ------- docs/zh-CN/1.0.11/search/index.html | 110 ------- docs/zh-CN/1.0.11/site-config.html | 235 -------------- docs/zh-CN/1.0.11/site-config/index.html | 235 -------------- docs/zh-CN/1.0.11/site-creation.html | 114 ------- docs/zh-CN/1.0.11/site-creation/index.html | 114 ------- docs/zh-CN/1.0.11/site-preparation.html | 103 ------- docs/zh-CN/1.0.11/site-preparation/index.html | 103 ------- docs/zh-CN/1.0.11/translation.html | 241 --------------- docs/zh-CN/1.0.11/translation/index.html | 241 --------------- docs/zh-CN/1.0.11/versioning.html | 112 ------- docs/zh-CN/1.0.11/versioning/index.html | 112 ------- docs/zh-CN/1.0.12/api-pages.html | 185 ----------- docs/zh-CN/1.0.12/api-pages/index.html | 185 ----------- docs/zh-CN/1.0.12/blog.html | 134 -------- docs/zh-CN/1.0.12/blog/index.html | 134 -------- docs/zh-CN/1.0.12/commands.html | 143 --------- docs/zh-CN/1.0.12/commands/index.html | 143 --------- docs/zh-CN/1.0.12/custom-pages.html | 115 ------- docs/zh-CN/1.0.12/custom-pages/index.html | 115 ------- docs/zh-CN/1.0.12/doc-markdown.html | 176 ----------- docs/zh-CN/1.0.12/doc-markdown/index.html | 176 ----------- docs/zh-CN/1.0.12/installation.html | 114 ------- docs/zh-CN/1.0.12/installation/index.html | 114 ------- docs/zh-CN/1.0.12/navigation.html | 191 ------------ docs/zh-CN/1.0.12/navigation/index.html | 191 ------------ docs/zh-CN/1.0.12/publishing.html | 204 ------------ docs/zh-CN/1.0.12/publishing/index.html | 204 ------------ docs/zh-CN/1.0.12/search.html | 110 ------- docs/zh-CN/1.0.12/search/index.html | 110 ------- docs/zh-CN/1.0.12/site-config.html | 238 -------------- docs/zh-CN/1.0.12/site-config/index.html | 238 -------------- docs/zh-CN/1.0.12/site-creation.html | 114 ------- docs/zh-CN/1.0.12/site-creation/index.html | 114 ------- docs/zh-CN/1.0.12/site-preparation.html | 103 ------- docs/zh-CN/1.0.12/site-preparation/index.html | 103 ------- docs/zh-CN/1.0.12/translation.html | 241 --------------- docs/zh-CN/1.0.12/translation/index.html | 241 --------------- docs/zh-CN/1.0.12/versioning.html | 124 -------- docs/zh-CN/1.0.12/versioning/index.html | 124 -------- docs/zh-CN/1.0.13/api-pages.html | 185 ----------- docs/zh-CN/1.0.13/api-pages/index.html | 185 ----------- docs/zh-CN/1.0.13/blog.html | 134 -------- docs/zh-CN/1.0.13/blog/index.html | 134 -------- docs/zh-CN/1.0.13/commands.html | 143 --------- docs/zh-CN/1.0.13/commands/index.html | 143 --------- docs/zh-CN/1.0.13/custom-pages.html | 115 ------- docs/zh-CN/1.0.13/custom-pages/index.html | 115 ------- docs/zh-CN/1.0.13/doc-markdown.html | 176 ----------- docs/zh-CN/1.0.13/doc-markdown/index.html | 176 ----------- docs/zh-CN/1.0.13/installation.html | 114 ------- docs/zh-CN/1.0.13/installation/index.html | 114 ------- docs/zh-CN/1.0.13/navigation.html | 191 ------------ docs/zh-CN/1.0.13/navigation/index.html | 191 ------------ docs/zh-CN/1.0.13/publishing.html | 204 ------------ docs/zh-CN/1.0.13/publishing/index.html | 204 ------------ docs/zh-CN/1.0.13/search.html | 110 ------- docs/zh-CN/1.0.13/search/index.html | 110 ------- docs/zh-CN/1.0.13/site-config.html | 239 -------------- docs/zh-CN/1.0.13/site-config/index.html | 239 -------------- docs/zh-CN/1.0.13/site-creation.html | 114 ------- docs/zh-CN/1.0.13/site-creation/index.html | 114 ------- docs/zh-CN/1.0.13/site-preparation.html | 103 ------- docs/zh-CN/1.0.13/site-preparation/index.html | 103 ------- docs/zh-CN/1.0.13/translation.html | 241 --------------- docs/zh-CN/1.0.13/translation/index.html | 241 --------------- docs/zh-CN/1.0.13/versioning.html | 124 -------- docs/zh-CN/1.0.13/versioning/index.html | 124 -------- docs/zh-CN/1.0.14/api-pages.html | 185 ----------- docs/zh-CN/1.0.14/api-pages/index.html | 185 ----------- docs/zh-CN/1.0.14/blog.html | 195 ------------ docs/zh-CN/1.0.14/blog/index.html | 195 ------------ docs/zh-CN/1.0.14/commands.html | 143 --------- docs/zh-CN/1.0.14/commands/index.html | 143 --------- docs/zh-CN/1.0.14/custom-pages.html | 115 ------- docs/zh-CN/1.0.14/custom-pages/index.html | 115 ------- docs/zh-CN/1.0.14/doc-markdown.html | 176 ----------- docs/zh-CN/1.0.14/doc-markdown/index.html | 176 ----------- docs/zh-CN/1.0.14/installation.html | 110 ------- docs/zh-CN/1.0.14/installation/index.html | 110 ------- docs/zh-CN/1.0.14/navigation.html | 191 ------------ docs/zh-CN/1.0.14/navigation/index.html | 191 ------------ docs/zh-CN/1.0.14/publishing.html | 225 -------------- docs/zh-CN/1.0.14/publishing/index.html | 225 -------------- docs/zh-CN/1.0.14/search.html | 110 ------- docs/zh-CN/1.0.14/search/index.html | 110 ------- docs/zh-CN/1.0.14/site-config.html | 239 -------------- docs/zh-CN/1.0.14/site-config/index.html | 239 -------------- docs/zh-CN/1.0.14/site-creation.html | 142 --------- docs/zh-CN/1.0.14/site-creation/index.html | 142 --------- docs/zh-CN/1.0.14/site-preparation.html | 103 ------- docs/zh-CN/1.0.14/site-preparation/index.html | 103 ------- docs/zh-CN/1.0.14/translation.html | 241 --------------- docs/zh-CN/1.0.14/translation/index.html | 241 --------------- docs/zh-CN/1.0.14/versioning.html | 124 -------- docs/zh-CN/1.0.14/versioning/index.html | 124 -------- docs/zh-CN/1.0.15/api-pages.html | 185 ----------- docs/zh-CN/1.0.15/api-pages/index.html | 185 ----------- docs/zh-CN/1.0.15/blog.html | 186 ----------- docs/zh-CN/1.0.15/blog/index.html | 186 ----------- docs/zh-CN/1.0.15/commands.html | 143 --------- docs/zh-CN/1.0.15/commands/index.html | 143 --------- docs/zh-CN/1.0.15/custom-pages.html | 115 ------- docs/zh-CN/1.0.15/custom-pages/index.html | 115 ------- docs/zh-CN/1.0.15/doc-markdown.html | 182 ----------- docs/zh-CN/1.0.15/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.0.15/installation.html | 111 ------- docs/zh-CN/1.0.15/installation/index.html | 111 ------- docs/zh-CN/1.0.15/navigation.html | 218 ------------- docs/zh-CN/1.0.15/navigation/index.html | 218 ------------- docs/zh-CN/1.0.15/publishing.html | 224 -------------- docs/zh-CN/1.0.15/publishing/index.html | 224 -------------- docs/zh-CN/1.0.15/search.html | 100 ------ docs/zh-CN/1.0.15/search/index.html | 100 ------ docs/zh-CN/1.0.15/site-config.html | 243 --------------- docs/zh-CN/1.0.15/site-config/index.html | 243 --------------- docs/zh-CN/1.0.15/site-creation.html | 142 --------- docs/zh-CN/1.0.15/site-creation/index.html | 142 --------- docs/zh-CN/1.0.15/site-preparation.html | 103 ------- docs/zh-CN/1.0.15/site-preparation/index.html | 103 ------- docs/zh-CN/1.0.15/translation.html | 243 --------------- docs/zh-CN/1.0.15/translation/index.html | 243 --------------- docs/zh-CN/1.0.15/versioning.html | 124 -------- docs/zh-CN/1.0.15/versioning/index.html | 124 -------- docs/zh-CN/1.1.0/api-pages.html | 185 ----------- docs/zh-CN/1.1.0/api-pages/index.html | 185 ----------- docs/zh-CN/1.1.0/blog.html | 186 ----------- docs/zh-CN/1.1.0/blog/index.html | 186 ----------- docs/zh-CN/1.1.0/commands.html | 182 ----------- docs/zh-CN/1.1.0/commands/index.html | 182 ----------- docs/zh-CN/1.1.0/custom-pages.html | 115 ------- docs/zh-CN/1.1.0/custom-pages/index.html | 115 ------- docs/zh-CN/1.1.0/doc-markdown.html | 182 ----------- docs/zh-CN/1.1.0/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.1.0/installation.html | 111 ------- docs/zh-CN/1.1.0/installation/index.html | 111 ------- docs/zh-CN/1.1.0/navigation.html | 218 ------------- docs/zh-CN/1.1.0/navigation/index.html | 218 ------------- docs/zh-CN/1.1.0/publishing.html | 224 -------------- docs/zh-CN/1.1.0/publishing/index.html | 224 -------------- docs/zh-CN/1.1.0/search.html | 100 ------ docs/zh-CN/1.1.0/search/index.html | 100 ------ docs/zh-CN/1.1.0/site-config.html | 251 --------------- docs/zh-CN/1.1.0/site-config/index.html | 251 --------------- docs/zh-CN/1.1.0/site-creation.html | 142 --------- docs/zh-CN/1.1.0/site-creation/index.html | 142 --------- docs/zh-CN/1.1.0/site-preparation.html | 103 ------- docs/zh-CN/1.1.0/site-preparation/index.html | 103 ------- docs/zh-CN/1.1.0/translation.html | 243 --------------- docs/zh-CN/1.1.0/translation/index.html | 243 --------------- docs/zh-CN/1.1.0/versioning.html | 124 -------- docs/zh-CN/1.1.0/versioning/index.html | 124 -------- docs/zh-CN/1.1.1/api-pages.html | 185 ----------- docs/zh-CN/1.1.1/api-pages/index.html | 185 ----------- docs/zh-CN/1.1.1/blog.html | 186 ----------- docs/zh-CN/1.1.1/blog/index.html | 186 ----------- docs/zh-CN/1.1.1/commands.html | 182 ----------- docs/zh-CN/1.1.1/commands/index.html | 182 ----------- docs/zh-CN/1.1.1/custom-pages.html | 115 ------- docs/zh-CN/1.1.1/custom-pages/index.html | 115 ------- docs/zh-CN/1.1.1/doc-markdown.html | 182 ----------- docs/zh-CN/1.1.1/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.1.1/installation.html | 111 ------- docs/zh-CN/1.1.1/installation/index.html | 111 ------- docs/zh-CN/1.1.1/navigation.html | 218 ------------- docs/zh-CN/1.1.1/navigation/index.html | 218 ------------- docs/zh-CN/1.1.1/publishing.html | 224 -------------- docs/zh-CN/1.1.1/publishing/index.html | 224 -------------- docs/zh-CN/1.1.1/search.html | 100 ------ docs/zh-CN/1.1.1/search/index.html | 100 ------ docs/zh-CN/1.1.1/site-config.html | 251 --------------- docs/zh-CN/1.1.1/site-config/index.html | 251 --------------- docs/zh-CN/1.1.1/site-creation.html | 142 --------- docs/zh-CN/1.1.1/site-creation/index.html | 142 --------- docs/zh-CN/1.1.1/site-preparation.html | 103 ------- docs/zh-CN/1.1.1/site-preparation/index.html | 103 ------- docs/zh-CN/1.1.1/translation.html | 243 --------------- docs/zh-CN/1.1.1/translation/index.html | 243 --------------- docs/zh-CN/1.1.1/versioning.html | 124 -------- docs/zh-CN/1.1.1/versioning/index.html | 124 -------- docs/zh-CN/1.1.2/api-pages.html | 185 ----------- docs/zh-CN/1.1.2/api-pages/index.html | 185 ----------- docs/zh-CN/1.1.2/blog.html | 186 ----------- docs/zh-CN/1.1.2/blog/index.html | 186 ----------- docs/zh-CN/1.1.2/commands.html | 182 ----------- docs/zh-CN/1.1.2/commands/index.html | 182 ----------- docs/zh-CN/1.1.2/custom-pages.html | 115 ------- docs/zh-CN/1.1.2/custom-pages/index.html | 115 ------- docs/zh-CN/1.1.2/doc-markdown.html | 182 ----------- docs/zh-CN/1.1.2/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.1.2/installation.html | 111 ------- docs/zh-CN/1.1.2/installation/index.html | 111 ------- docs/zh-CN/1.1.2/navigation.html | 218 ------------- docs/zh-CN/1.1.2/navigation/index.html | 218 ------------- docs/zh-CN/1.1.2/publishing.html | 224 -------------- docs/zh-CN/1.1.2/publishing/index.html | 224 -------------- docs/zh-CN/1.1.2/search.html | 100 ------ docs/zh-CN/1.1.2/search/index.html | 100 ------ docs/zh-CN/1.1.2/site-config.html | 251 --------------- docs/zh-CN/1.1.2/site-config/index.html | 251 --------------- docs/zh-CN/1.1.2/site-creation.html | 142 --------- docs/zh-CN/1.1.2/site-creation/index.html | 142 --------- docs/zh-CN/1.1.2/site-preparation.html | 103 ------- docs/zh-CN/1.1.2/site-preparation/index.html | 103 ------- docs/zh-CN/1.1.2/translation.html | 243 --------------- docs/zh-CN/1.1.2/translation/index.html | 243 --------------- docs/zh-CN/1.1.2/versioning.html | 124 -------- docs/zh-CN/1.1.2/versioning/index.html | 124 -------- docs/zh-CN/1.1.3/api-pages.html | 185 ----------- docs/zh-CN/1.1.3/api-pages/index.html | 185 ----------- docs/zh-CN/1.1.3/blog.html | 186 ----------- docs/zh-CN/1.1.3/blog/index.html | 186 ----------- docs/zh-CN/1.1.3/commands.html | 182 ----------- docs/zh-CN/1.1.3/commands/index.html | 182 ----------- docs/zh-CN/1.1.3/custom-pages.html | 115 ------- docs/zh-CN/1.1.3/custom-pages/index.html | 115 ------- docs/zh-CN/1.1.3/doc-markdown.html | 182 ----------- docs/zh-CN/1.1.3/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.1.3/installation.html | 116 ------- docs/zh-CN/1.1.3/installation/index.html | 116 ------- docs/zh-CN/1.1.3/navigation.html | 218 ------------- docs/zh-CN/1.1.3/navigation/index.html | 218 ------------- docs/zh-CN/1.1.3/publishing.html | 224 -------------- docs/zh-CN/1.1.3/publishing/index.html | 224 -------------- docs/zh-CN/1.1.3/search.html | 100 ------ docs/zh-CN/1.1.3/search/index.html | 100 ------ docs/zh-CN/1.1.3/site-config.html | 251 --------------- docs/zh-CN/1.1.3/site-config/index.html | 251 --------------- docs/zh-CN/1.1.3/site-creation.html | 142 --------- docs/zh-CN/1.1.3/site-creation/index.html | 142 --------- docs/zh-CN/1.1.3/site-preparation.html | 103 ------- docs/zh-CN/1.1.3/site-preparation/index.html | 103 ------- docs/zh-CN/1.1.3/translation.html | 243 --------------- docs/zh-CN/1.1.3/translation/index.html | 243 --------------- docs/zh-CN/1.1.3/versioning.html | 124 -------- docs/zh-CN/1.1.3/versioning/index.html | 124 -------- docs/zh-CN/1.1.4/api-pages.html | 185 ----------- docs/zh-CN/1.1.4/api-pages/index.html | 185 ----------- docs/zh-CN/1.1.4/blog.html | 186 ----------- docs/zh-CN/1.1.4/blog/index.html | 186 ----------- docs/zh-CN/1.1.4/commands.html | 182 ----------- docs/zh-CN/1.1.4/commands/index.html | 182 ----------- docs/zh-CN/1.1.4/custom-pages.html | 115 ------- docs/zh-CN/1.1.4/custom-pages/index.html | 115 ------- docs/zh-CN/1.1.4/doc-markdown.html | 182 ----------- docs/zh-CN/1.1.4/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.1.4/installation.html | 118 ------- docs/zh-CN/1.1.4/installation/index.html | 118 ------- docs/zh-CN/1.1.4/navigation.html | 218 ------------- docs/zh-CN/1.1.4/navigation/index.html | 218 ------------- docs/zh-CN/1.1.4/publishing.html | 224 -------------- docs/zh-CN/1.1.4/publishing/index.html | 224 -------------- docs/zh-CN/1.1.4/search.html | 100 ------ docs/zh-CN/1.1.4/search/index.html | 100 ------ docs/zh-CN/1.1.4/site-config.html | 251 --------------- docs/zh-CN/1.1.4/site-config/index.html | 251 --------------- docs/zh-CN/1.1.4/site-creation.html | 142 --------- docs/zh-CN/1.1.4/site-creation/index.html | 142 --------- docs/zh-CN/1.1.4/site-preparation.html | 105 ------- docs/zh-CN/1.1.4/site-preparation/index.html | 105 ------- docs/zh-CN/1.1.4/translation.html | 243 --------------- docs/zh-CN/1.1.4/translation/index.html | 243 --------------- docs/zh-CN/1.1.4/versioning.html | 124 -------- docs/zh-CN/1.1.4/versioning/index.html | 124 -------- docs/zh-CN/1.1.5/api-pages.html | 185 ----------- docs/zh-CN/1.1.5/api-pages/index.html | 185 ----------- docs/zh-CN/1.1.5/blog.html | 186 ----------- docs/zh-CN/1.1.5/blog/index.html | 186 ----------- docs/zh-CN/1.1.5/commands.html | 182 ----------- docs/zh-CN/1.1.5/commands/index.html | 182 ----------- docs/zh-CN/1.1.5/custom-pages.html | 115 ------- docs/zh-CN/1.1.5/custom-pages/index.html | 115 ------- docs/zh-CN/1.1.5/doc-markdown.html | 182 ----------- docs/zh-CN/1.1.5/doc-markdown/index.html | 182 ----------- docs/zh-CN/1.1.5/installation.html | 118 ------- docs/zh-CN/1.1.5/installation/index.html | 118 ------- docs/zh-CN/1.1.5/navigation.html | 218 ------------- docs/zh-CN/1.1.5/navigation/index.html | 218 ------------- docs/zh-CN/1.1.5/publishing.html | 224 -------------- docs/zh-CN/1.1.5/publishing/index.html | 224 -------------- docs/zh-CN/1.1.5/search.html | 100 ------ docs/zh-CN/1.1.5/search/index.html | 100 ------ docs/zh-CN/1.1.5/site-config.html | 251 --------------- docs/zh-CN/1.1.5/site-config/index.html | 251 --------------- docs/zh-CN/1.1.5/site-creation.html | 142 --------- docs/zh-CN/1.1.5/site-creation/index.html | 142 --------- docs/zh-CN/1.1.5/site-preparation.html | 105 ------- docs/zh-CN/1.1.5/site-preparation/index.html | 105 ------- docs/zh-CN/1.1.5/translation.html | 243 --------------- docs/zh-CN/1.1.5/translation/index.html | 243 --------------- docs/zh-CN/1.1.5/versioning.html | 124 -------- docs/zh-CN/1.1.5/versioning/index.html | 124 -------- docs/zh-CN/1.2.0/api-pages.html | 219 ------------- docs/zh-CN/1.2.0/api-pages/index.html | 219 ------------- docs/zh-CN/1.2.0/blog.html | 186 ----------- docs/zh-CN/1.2.0/blog/index.html | 186 ----------- docs/zh-CN/1.2.0/commands.html | 182 ----------- docs/zh-CN/1.2.0/commands/index.html | 182 ----------- docs/zh-CN/1.2.0/custom-pages.html | 114 ------- docs/zh-CN/1.2.0/custom-pages/index.html | 114 ------- docs/zh-CN/1.2.0/doc-markdown.html | 197 ------------ docs/zh-CN/1.2.0/doc-markdown/index.html | 197 ------------ docs/zh-CN/1.2.0/installation.html | 118 ------- docs/zh-CN/1.2.0/installation/index.html | 118 ------- docs/zh-CN/1.2.0/navigation.html | 231 -------------- docs/zh-CN/1.2.0/navigation/index.html | 231 -------------- docs/zh-CN/1.2.0/publishing.html | 259 ---------------- docs/zh-CN/1.2.0/publishing/index.html | 259 ---------------- docs/zh-CN/1.2.0/search.html | 100 ------ docs/zh-CN/1.2.0/search/index.html | 100 ------ docs/zh-CN/1.2.0/site-config.html | 261 ---------------- docs/zh-CN/1.2.0/site-config/index.html | 261 ---------------- docs/zh-CN/1.2.0/site-creation.html | 143 --------- docs/zh-CN/1.2.0/site-creation/index.html | 143 --------- docs/zh-CN/1.2.0/site-preparation.html | 105 ------- docs/zh-CN/1.2.0/site-preparation/index.html | 105 ------- docs/zh-CN/1.2.0/translation.html | 243 --------------- docs/zh-CN/1.2.0/translation/index.html | 243 --------------- docs/zh-CN/1.2.0/versioning.html | 124 -------- docs/zh-CN/1.2.0/versioning/index.html | 124 -------- docs/zh-CN/1.2.1/api-pages.html | 219 ------------- docs/zh-CN/1.2.1/api-pages/index.html | 219 ------------- docs/zh-CN/1.2.1/blog.html | 192 ------------ docs/zh-CN/1.2.1/blog/index.html | 192 ------------ docs/zh-CN/1.2.1/commands.html | 183 ----------- docs/zh-CN/1.2.1/commands/index.html | 183 ----------- docs/zh-CN/1.2.1/custom-pages.html | 114 ------- docs/zh-CN/1.2.1/custom-pages/index.html | 114 ------- docs/zh-CN/1.2.1/doc-markdown.html | 197 ------------ docs/zh-CN/1.2.1/doc-markdown/index.html | 197 ------------ docs/zh-CN/1.2.1/installation.html | 145 --------- docs/zh-CN/1.2.1/installation/index.html | 145 --------- docs/zh-CN/1.2.1/navigation.html | 231 -------------- docs/zh-CN/1.2.1/navigation/index.html | 231 -------------- docs/zh-CN/1.2.1/publishing.html | 260 ---------------- docs/zh-CN/1.2.1/publishing/index.html | 260 ---------------- docs/zh-CN/1.2.1/search.html | 112 ------- docs/zh-CN/1.2.1/search/index.html | 112 ------- docs/zh-CN/1.2.1/site-config.html | 262 ---------------- docs/zh-CN/1.2.1/site-config/index.html | 262 ---------------- docs/zh-CN/1.2.1/site-creation.html | 143 --------- docs/zh-CN/1.2.1/site-creation/index.html | 143 --------- docs/zh-CN/1.2.1/site-preparation.html | 105 ------- docs/zh-CN/1.2.1/site-preparation/index.html | 105 ------- docs/zh-CN/1.2.1/translation.html | 269 ---------------- docs/zh-CN/1.2.1/translation/index.html | 269 ---------------- docs/zh-CN/1.2.1/versioning.html | 124 -------- docs/zh-CN/1.2.1/versioning/index.html | 124 -------- docs/zh-CN/1.3.0/adding-blog.html | 192 ------------ docs/zh-CN/1.3.0/adding-blog/index.html | 192 ------------ docs/zh-CN/1.3.0/api-pages.html | 219 ------------- docs/zh-CN/1.3.0/api-pages/index.html | 219 ------------- docs/zh-CN/1.3.0/blog.html | 165 ---------- docs/zh-CN/1.3.0/blog/index.html | 165 ---------- docs/zh-CN/1.3.0/commands.html | 183 ----------- docs/zh-CN/1.3.0/commands/index.html | 183 ----------- docs/zh-CN/1.3.0/custom-pages.html | 114 ------- docs/zh-CN/1.3.0/custom-pages/index.html | 114 ------- docs/zh-CN/1.3.0/doc-markdown.html | 198 ------------ docs/zh-CN/1.3.0/doc-markdown/index.html | 198 ------------ docs/zh-CN/1.3.0/installation.html | 145 --------- docs/zh-CN/1.3.0/installation/index.html | 145 --------- docs/zh-CN/1.3.0/navigation.html | 231 -------------- docs/zh-CN/1.3.0/navigation/index.html | 231 -------------- docs/zh-CN/1.3.0/publishing.html | 260 ---------------- docs/zh-CN/1.3.0/publishing/index.html | 260 ---------------- docs/zh-CN/1.3.0/search.html | 112 ------- docs/zh-CN/1.3.0/search/index.html | 112 ------- docs/zh-CN/1.3.0/site-config.html | 262 ---------------- docs/zh-CN/1.3.0/site-config/index.html | 262 ---------------- docs/zh-CN/1.3.0/site-creation.html | 143 --------- docs/zh-CN/1.3.0/site-creation/index.html | 143 --------- docs/zh-CN/1.3.0/site-preparation.html | 105 ------- docs/zh-CN/1.3.0/site-preparation/index.html | 105 ------- docs/zh-CN/1.3.0/translation.html | 269 ---------------- docs/zh-CN/1.3.0/translation/index.html | 269 ---------------- docs/zh-CN/1.3.0/versioning.html | 124 -------- docs/zh-CN/1.3.0/versioning/index.html | 124 -------- docs/zh-CN/1.3.1/adding-blog.html | 192 ------------ docs/zh-CN/1.3.1/adding-blog/index.html | 192 ------------ docs/zh-CN/1.3.1/api-pages.html | 219 ------------- docs/zh-CN/1.3.1/api-pages/index.html | 219 ------------- docs/zh-CN/1.3.1/blog.html | 165 ---------- docs/zh-CN/1.3.1/blog/index.html | 165 ---------- docs/zh-CN/1.3.1/commands.html | 183 ----------- docs/zh-CN/1.3.1/commands/index.html | 183 ----------- docs/zh-CN/1.3.1/custom-pages.html | 114 ------- docs/zh-CN/1.3.1/custom-pages/index.html | 114 ------- docs/zh-CN/1.3.1/doc-markdown.html | 198 ------------ docs/zh-CN/1.3.1/doc-markdown/index.html | 198 ------------ docs/zh-CN/1.3.1/installation.html | 145 --------- docs/zh-CN/1.3.1/installation/index.html | 145 --------- docs/zh-CN/1.3.1/navigation.html | 231 -------------- docs/zh-CN/1.3.1/navigation/index.html | 231 -------------- docs/zh-CN/1.3.1/publishing.html | 260 ---------------- docs/zh-CN/1.3.1/publishing/index.html | 260 ---------------- docs/zh-CN/1.3.1/search.html | 112 ------- docs/zh-CN/1.3.1/search/index.html | 112 ------- docs/zh-CN/1.3.1/site-config.html | 262 ---------------- docs/zh-CN/1.3.1/site-config/index.html | 262 ---------------- docs/zh-CN/1.3.1/site-creation.html | 143 --------- docs/zh-CN/1.3.1/site-creation/index.html | 143 --------- docs/zh-CN/1.3.1/site-preparation.html | 105 ------- docs/zh-CN/1.3.1/site-preparation/index.html | 105 ------- docs/zh-CN/1.3.1/translation.html | 269 ---------------- docs/zh-CN/1.3.1/translation/index.html | 269 ---------------- docs/zh-CN/1.3.1/versioning.html | 124 -------- docs/zh-CN/1.3.1/versioning/index.html | 124 -------- docs/zh-CN/1.3.2/adding-blog.html | 192 ------------ docs/zh-CN/1.3.2/adding-blog/index.html | 192 ------------ docs/zh-CN/1.3.2/api-pages.html | 219 ------------- docs/zh-CN/1.3.2/api-pages/index.html | 219 ------------- docs/zh-CN/1.3.2/blog.html | 165 ---------- docs/zh-CN/1.3.2/blog/index.html | 165 ---------- docs/zh-CN/1.3.2/commands.html | 183 ----------- docs/zh-CN/1.3.2/commands/index.html | 183 ----------- docs/zh-CN/1.3.2/custom-pages.html | 114 ------- docs/zh-CN/1.3.2/custom-pages/index.html | 114 ------- docs/zh-CN/1.3.2/doc-markdown.html | 198 ------------ docs/zh-CN/1.3.2/doc-markdown/index.html | 198 ------------ docs/zh-CN/1.3.2/installation.html | 145 --------- docs/zh-CN/1.3.2/installation/index.html | 145 --------- docs/zh-CN/1.3.2/navigation.html | 231 -------------- docs/zh-CN/1.3.2/navigation/index.html | 231 -------------- docs/zh-CN/1.3.2/publishing.html | 260 ---------------- docs/zh-CN/1.3.2/publishing/index.html | 260 ---------------- docs/zh-CN/1.3.2/search.html | 112 ------- docs/zh-CN/1.3.2/search/index.html | 112 ------- docs/zh-CN/1.3.2/site-config.html | 262 ---------------- docs/zh-CN/1.3.2/site-config/index.html | 262 ---------------- docs/zh-CN/1.3.2/site-creation.html | 143 --------- docs/zh-CN/1.3.2/site-creation/index.html | 143 --------- docs/zh-CN/1.3.2/site-preparation.html | 105 ------- docs/zh-CN/1.3.2/site-preparation/index.html | 105 ------- docs/zh-CN/1.3.2/translation.html | 269 ---------------- docs/zh-CN/1.3.2/translation/index.html | 269 ---------------- docs/zh-CN/1.3.2/versioning.html | 124 -------- docs/zh-CN/1.3.2/versioning/index.html | 124 -------- docs/zh-CN/adding-blog.html | 192 ------------ docs/zh-CN/adding-blog/index.html | 192 ------------ docs/zh-CN/api-pages.html | 219 ------------- docs/zh-CN/api-pages/index.html | 219 ------------- docs/zh-CN/blog.html | 165 ---------- docs/zh-CN/blog/index.html | 165 ---------- docs/zh-CN/commands.html | 183 ----------- docs/zh-CN/commands/index.html | 183 ----------- docs/zh-CN/custom-pages.html | 114 ------- docs/zh-CN/custom-pages/index.html | 114 ------- docs/zh-CN/doc-markdown.html | 198 ------------ docs/zh-CN/doc-markdown/index.html | 198 ------------ docs/zh-CN/installation.html | 153 --------- docs/zh-CN/installation/index.html | 153 --------- docs/zh-CN/navigation.html | 231 -------------- docs/zh-CN/navigation/index.html | 231 -------------- docs/zh-CN/next/adding-blog.html | 192 ------------ docs/zh-CN/next/adding-blog/index.html | 192 ------------ docs/zh-CN/next/api-pages.html | 219 ------------- docs/zh-CN/next/api-pages/index.html | 219 ------------- docs/zh-CN/next/commands.html | 183 ----------- docs/zh-CN/next/commands/index.html | 183 ----------- docs/zh-CN/next/custom-pages.html | 114 ------- docs/zh-CN/next/custom-pages/index.html | 114 ------- docs/zh-CN/next/doc-markdown.html | 198 ------------ docs/zh-CN/next/doc-markdown/index.html | 198 ------------ docs/zh-CN/next/docker.html | 115 ------- docs/zh-CN/next/docker/index.html | 115 ------- docs/zh-CN/next/installation.html | 153 --------- docs/zh-CN/next/installation/index.html | 153 --------- docs/zh-CN/next/navigation.html | 231 -------------- docs/zh-CN/next/navigation/index.html | 231 -------------- docs/zh-CN/next/publishing.html | 260 ---------------- docs/zh-CN/next/publishing/index.html | 260 ---------------- docs/zh-CN/next/search.html | 112 ------- docs/zh-CN/next/search/index.html | 112 ------- docs/zh-CN/next/site-config.html | 276 ----------------- docs/zh-CN/next/site-config/index.html | 276 ----------------- docs/zh-CN/next/site-creation.html | 143 --------- docs/zh-CN/next/site-creation/index.html | 143 --------- docs/zh-CN/next/site-preparation.html | 111 ------- docs/zh-CN/next/site-preparation/index.html | 111 ------- docs/zh-CN/next/translation.html | 291 ------------------ docs/zh-CN/next/translation/index.html | 291 ------------------ docs/zh-CN/next/versioning.html | 124 -------- docs/zh-CN/next/versioning/index.html | 124 -------- docs/zh-CN/publishing.html | 260 ---------------- docs/zh-CN/publishing/index.html | 260 ---------------- docs/zh-CN/search.html | 112 ------- docs/zh-CN/search/index.html | 112 ------- docs/zh-CN/site-config.html | 262 ---------------- docs/zh-CN/site-config/index.html | 262 ---------------- docs/zh-CN/site-creation.html | 143 --------- docs/zh-CN/site-creation/index.html | 143 --------- docs/zh-CN/site-preparation.html | 111 ------- docs/zh-CN/site-preparation/index.html | 111 ------- docs/zh-CN/translation.html | 283 ----------------- docs/zh-CN/translation/index.html | 283 ----------------- docs/zh-CN/versioning.html | 124 -------- docs/zh-CN/versioning/index.html | 124 -------- zh-CN/about-slash.html | 6 +- zh-CN/about-slash/index.html | 6 +- zh-CN/help.html | 8 +- zh-CN/help/index.html | 8 +- zh-CN/index.html | 22 +- zh-CN/users.html | 6 +- zh-CN/users/index.html | 6 +- zh-CN/versions.html | 4 +- zh-CN/versions/index.html | 4 +- 523 files changed, 35 insertions(+), 88141 deletions(-) delete mode 100644 docs/zh-CN/1.0.11/api-pages.html delete mode 100644 docs/zh-CN/1.0.11/api-pages/index.html delete mode 100644 docs/zh-CN/1.0.11/blog.html delete mode 100644 docs/zh-CN/1.0.11/blog/index.html delete mode 100644 docs/zh-CN/1.0.11/commands.html delete mode 100644 docs/zh-CN/1.0.11/commands/index.html delete mode 100644 docs/zh-CN/1.0.11/custom-pages.html delete mode 100644 docs/zh-CN/1.0.11/custom-pages/index.html delete mode 100644 docs/zh-CN/1.0.11/doc-markdown.html delete mode 100644 docs/zh-CN/1.0.11/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.0.11/installation.html delete mode 100644 docs/zh-CN/1.0.11/installation/index.html delete mode 100644 docs/zh-CN/1.0.11/navigation.html delete mode 100644 docs/zh-CN/1.0.11/navigation/index.html delete mode 100644 docs/zh-CN/1.0.11/publishing.html delete mode 100644 docs/zh-CN/1.0.11/publishing/index.html delete mode 100644 docs/zh-CN/1.0.11/search.html delete mode 100644 docs/zh-CN/1.0.11/search/index.html delete mode 100644 docs/zh-CN/1.0.11/site-config.html delete mode 100644 docs/zh-CN/1.0.11/site-config/index.html delete mode 100644 docs/zh-CN/1.0.11/site-creation.html delete mode 100644 docs/zh-CN/1.0.11/site-creation/index.html delete mode 100644 docs/zh-CN/1.0.11/site-preparation.html delete mode 100644 docs/zh-CN/1.0.11/site-preparation/index.html delete mode 100644 docs/zh-CN/1.0.11/translation.html delete mode 100644 docs/zh-CN/1.0.11/translation/index.html delete mode 100644 docs/zh-CN/1.0.11/versioning.html delete mode 100644 docs/zh-CN/1.0.11/versioning/index.html delete mode 100644 docs/zh-CN/1.0.12/api-pages.html delete mode 100644 docs/zh-CN/1.0.12/api-pages/index.html delete mode 100644 docs/zh-CN/1.0.12/blog.html delete mode 100644 docs/zh-CN/1.0.12/blog/index.html delete mode 100644 docs/zh-CN/1.0.12/commands.html delete mode 100644 docs/zh-CN/1.0.12/commands/index.html delete mode 100644 docs/zh-CN/1.0.12/custom-pages.html delete mode 100644 docs/zh-CN/1.0.12/custom-pages/index.html delete mode 100644 docs/zh-CN/1.0.12/doc-markdown.html delete mode 100644 docs/zh-CN/1.0.12/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.0.12/installation.html delete mode 100644 docs/zh-CN/1.0.12/installation/index.html delete mode 100644 docs/zh-CN/1.0.12/navigation.html delete mode 100644 docs/zh-CN/1.0.12/navigation/index.html delete mode 100644 docs/zh-CN/1.0.12/publishing.html delete mode 100644 docs/zh-CN/1.0.12/publishing/index.html delete mode 100644 docs/zh-CN/1.0.12/search.html delete mode 100644 docs/zh-CN/1.0.12/search/index.html delete mode 100644 docs/zh-CN/1.0.12/site-config.html delete mode 100644 docs/zh-CN/1.0.12/site-config/index.html delete mode 100644 docs/zh-CN/1.0.12/site-creation.html delete mode 100644 docs/zh-CN/1.0.12/site-creation/index.html delete mode 100644 docs/zh-CN/1.0.12/site-preparation.html delete mode 100644 docs/zh-CN/1.0.12/site-preparation/index.html delete mode 100644 docs/zh-CN/1.0.12/translation.html delete mode 100644 docs/zh-CN/1.0.12/translation/index.html delete mode 100644 docs/zh-CN/1.0.12/versioning.html delete mode 100644 docs/zh-CN/1.0.12/versioning/index.html delete mode 100644 docs/zh-CN/1.0.13/api-pages.html delete mode 100644 docs/zh-CN/1.0.13/api-pages/index.html delete mode 100644 docs/zh-CN/1.0.13/blog.html delete mode 100644 docs/zh-CN/1.0.13/blog/index.html delete mode 100644 docs/zh-CN/1.0.13/commands.html delete mode 100644 docs/zh-CN/1.0.13/commands/index.html delete mode 100644 docs/zh-CN/1.0.13/custom-pages.html delete mode 100644 docs/zh-CN/1.0.13/custom-pages/index.html delete mode 100644 docs/zh-CN/1.0.13/doc-markdown.html delete mode 100644 docs/zh-CN/1.0.13/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.0.13/installation.html delete mode 100644 docs/zh-CN/1.0.13/installation/index.html delete mode 100644 docs/zh-CN/1.0.13/navigation.html delete mode 100644 docs/zh-CN/1.0.13/navigation/index.html delete mode 100644 docs/zh-CN/1.0.13/publishing.html delete mode 100644 docs/zh-CN/1.0.13/publishing/index.html delete mode 100644 docs/zh-CN/1.0.13/search.html delete mode 100644 docs/zh-CN/1.0.13/search/index.html delete mode 100644 docs/zh-CN/1.0.13/site-config.html delete mode 100644 docs/zh-CN/1.0.13/site-config/index.html delete mode 100644 docs/zh-CN/1.0.13/site-creation.html delete mode 100644 docs/zh-CN/1.0.13/site-creation/index.html delete mode 100644 docs/zh-CN/1.0.13/site-preparation.html delete mode 100644 docs/zh-CN/1.0.13/site-preparation/index.html delete mode 100644 docs/zh-CN/1.0.13/translation.html delete mode 100644 docs/zh-CN/1.0.13/translation/index.html delete mode 100644 docs/zh-CN/1.0.13/versioning.html delete mode 100644 docs/zh-CN/1.0.13/versioning/index.html delete mode 100644 docs/zh-CN/1.0.14/api-pages.html delete mode 100644 docs/zh-CN/1.0.14/api-pages/index.html delete mode 100644 docs/zh-CN/1.0.14/blog.html delete mode 100644 docs/zh-CN/1.0.14/blog/index.html delete mode 100644 docs/zh-CN/1.0.14/commands.html delete mode 100644 docs/zh-CN/1.0.14/commands/index.html delete mode 100644 docs/zh-CN/1.0.14/custom-pages.html delete mode 100644 docs/zh-CN/1.0.14/custom-pages/index.html delete mode 100644 docs/zh-CN/1.0.14/doc-markdown.html delete mode 100644 docs/zh-CN/1.0.14/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.0.14/installation.html delete mode 100644 docs/zh-CN/1.0.14/installation/index.html delete mode 100644 docs/zh-CN/1.0.14/navigation.html delete mode 100644 docs/zh-CN/1.0.14/navigation/index.html delete mode 100644 docs/zh-CN/1.0.14/publishing.html delete mode 100644 docs/zh-CN/1.0.14/publishing/index.html delete mode 100644 docs/zh-CN/1.0.14/search.html delete mode 100644 docs/zh-CN/1.0.14/search/index.html delete mode 100644 docs/zh-CN/1.0.14/site-config.html delete mode 100644 docs/zh-CN/1.0.14/site-config/index.html delete mode 100644 docs/zh-CN/1.0.14/site-creation.html delete mode 100644 docs/zh-CN/1.0.14/site-creation/index.html delete mode 100644 docs/zh-CN/1.0.14/site-preparation.html delete mode 100644 docs/zh-CN/1.0.14/site-preparation/index.html delete mode 100644 docs/zh-CN/1.0.14/translation.html delete mode 100644 docs/zh-CN/1.0.14/translation/index.html delete mode 100644 docs/zh-CN/1.0.14/versioning.html delete mode 100644 docs/zh-CN/1.0.14/versioning/index.html delete mode 100644 docs/zh-CN/1.0.15/api-pages.html delete mode 100644 docs/zh-CN/1.0.15/api-pages/index.html delete mode 100644 docs/zh-CN/1.0.15/blog.html delete mode 100644 docs/zh-CN/1.0.15/blog/index.html delete mode 100644 docs/zh-CN/1.0.15/commands.html delete mode 100644 docs/zh-CN/1.0.15/commands/index.html delete mode 100644 docs/zh-CN/1.0.15/custom-pages.html delete mode 100644 docs/zh-CN/1.0.15/custom-pages/index.html delete mode 100644 docs/zh-CN/1.0.15/doc-markdown.html delete mode 100644 docs/zh-CN/1.0.15/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.0.15/installation.html delete mode 100644 docs/zh-CN/1.0.15/installation/index.html delete mode 100644 docs/zh-CN/1.0.15/navigation.html delete mode 100644 docs/zh-CN/1.0.15/navigation/index.html delete mode 100644 docs/zh-CN/1.0.15/publishing.html delete mode 100644 docs/zh-CN/1.0.15/publishing/index.html delete mode 100644 docs/zh-CN/1.0.15/search.html delete mode 100644 docs/zh-CN/1.0.15/search/index.html delete mode 100644 docs/zh-CN/1.0.15/site-config.html delete mode 100644 docs/zh-CN/1.0.15/site-config/index.html delete mode 100644 docs/zh-CN/1.0.15/site-creation.html delete mode 100644 docs/zh-CN/1.0.15/site-creation/index.html delete mode 100644 docs/zh-CN/1.0.15/site-preparation.html delete mode 100644 docs/zh-CN/1.0.15/site-preparation/index.html delete mode 100644 docs/zh-CN/1.0.15/translation.html delete mode 100644 docs/zh-CN/1.0.15/translation/index.html delete mode 100644 docs/zh-CN/1.0.15/versioning.html delete mode 100644 docs/zh-CN/1.0.15/versioning/index.html delete mode 100644 docs/zh-CN/1.1.0/api-pages.html delete mode 100644 docs/zh-CN/1.1.0/api-pages/index.html delete mode 100644 docs/zh-CN/1.1.0/blog.html delete mode 100644 docs/zh-CN/1.1.0/blog/index.html delete mode 100644 docs/zh-CN/1.1.0/commands.html delete mode 100644 docs/zh-CN/1.1.0/commands/index.html delete mode 100644 docs/zh-CN/1.1.0/custom-pages.html delete mode 100644 docs/zh-CN/1.1.0/custom-pages/index.html delete mode 100644 docs/zh-CN/1.1.0/doc-markdown.html delete mode 100644 docs/zh-CN/1.1.0/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.1.0/installation.html delete mode 100644 docs/zh-CN/1.1.0/installation/index.html delete mode 100644 docs/zh-CN/1.1.0/navigation.html delete mode 100644 docs/zh-CN/1.1.0/navigation/index.html delete mode 100644 docs/zh-CN/1.1.0/publishing.html delete mode 100644 docs/zh-CN/1.1.0/publishing/index.html delete mode 100644 docs/zh-CN/1.1.0/search.html delete mode 100644 docs/zh-CN/1.1.0/search/index.html delete mode 100644 docs/zh-CN/1.1.0/site-config.html delete mode 100644 docs/zh-CN/1.1.0/site-config/index.html delete mode 100644 docs/zh-CN/1.1.0/site-creation.html delete mode 100644 docs/zh-CN/1.1.0/site-creation/index.html delete mode 100644 docs/zh-CN/1.1.0/site-preparation.html delete mode 100644 docs/zh-CN/1.1.0/site-preparation/index.html delete mode 100644 docs/zh-CN/1.1.0/translation.html delete mode 100644 docs/zh-CN/1.1.0/translation/index.html delete mode 100644 docs/zh-CN/1.1.0/versioning.html delete mode 100644 docs/zh-CN/1.1.0/versioning/index.html delete mode 100644 docs/zh-CN/1.1.1/api-pages.html delete mode 100644 docs/zh-CN/1.1.1/api-pages/index.html delete mode 100644 docs/zh-CN/1.1.1/blog.html delete mode 100644 docs/zh-CN/1.1.1/blog/index.html delete mode 100644 docs/zh-CN/1.1.1/commands.html delete mode 100644 docs/zh-CN/1.1.1/commands/index.html delete mode 100644 docs/zh-CN/1.1.1/custom-pages.html delete mode 100644 docs/zh-CN/1.1.1/custom-pages/index.html delete mode 100644 docs/zh-CN/1.1.1/doc-markdown.html delete mode 100644 docs/zh-CN/1.1.1/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.1.1/installation.html delete mode 100644 docs/zh-CN/1.1.1/installation/index.html delete mode 100644 docs/zh-CN/1.1.1/navigation.html delete mode 100644 docs/zh-CN/1.1.1/navigation/index.html delete mode 100644 docs/zh-CN/1.1.1/publishing.html delete mode 100644 docs/zh-CN/1.1.1/publishing/index.html delete mode 100644 docs/zh-CN/1.1.1/search.html delete mode 100644 docs/zh-CN/1.1.1/search/index.html delete mode 100644 docs/zh-CN/1.1.1/site-config.html delete mode 100644 docs/zh-CN/1.1.1/site-config/index.html delete mode 100644 docs/zh-CN/1.1.1/site-creation.html delete mode 100644 docs/zh-CN/1.1.1/site-creation/index.html delete mode 100644 docs/zh-CN/1.1.1/site-preparation.html delete mode 100644 docs/zh-CN/1.1.1/site-preparation/index.html delete mode 100644 docs/zh-CN/1.1.1/translation.html delete mode 100644 docs/zh-CN/1.1.1/translation/index.html delete mode 100644 docs/zh-CN/1.1.1/versioning.html delete mode 100644 docs/zh-CN/1.1.1/versioning/index.html delete mode 100644 docs/zh-CN/1.1.2/api-pages.html delete mode 100644 docs/zh-CN/1.1.2/api-pages/index.html delete mode 100644 docs/zh-CN/1.1.2/blog.html delete mode 100644 docs/zh-CN/1.1.2/blog/index.html delete mode 100644 docs/zh-CN/1.1.2/commands.html delete mode 100644 docs/zh-CN/1.1.2/commands/index.html delete mode 100644 docs/zh-CN/1.1.2/custom-pages.html delete mode 100644 docs/zh-CN/1.1.2/custom-pages/index.html delete mode 100644 docs/zh-CN/1.1.2/doc-markdown.html delete mode 100644 docs/zh-CN/1.1.2/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.1.2/installation.html delete mode 100644 docs/zh-CN/1.1.2/installation/index.html delete mode 100644 docs/zh-CN/1.1.2/navigation.html delete mode 100644 docs/zh-CN/1.1.2/navigation/index.html delete mode 100644 docs/zh-CN/1.1.2/publishing.html delete mode 100644 docs/zh-CN/1.1.2/publishing/index.html delete mode 100644 docs/zh-CN/1.1.2/search.html delete mode 100644 docs/zh-CN/1.1.2/search/index.html delete mode 100644 docs/zh-CN/1.1.2/site-config.html delete mode 100644 docs/zh-CN/1.1.2/site-config/index.html delete mode 100644 docs/zh-CN/1.1.2/site-creation.html delete mode 100644 docs/zh-CN/1.1.2/site-creation/index.html delete mode 100644 docs/zh-CN/1.1.2/site-preparation.html delete mode 100644 docs/zh-CN/1.1.2/site-preparation/index.html delete mode 100644 docs/zh-CN/1.1.2/translation.html delete mode 100644 docs/zh-CN/1.1.2/translation/index.html delete mode 100644 docs/zh-CN/1.1.2/versioning.html delete mode 100644 docs/zh-CN/1.1.2/versioning/index.html delete mode 100644 docs/zh-CN/1.1.3/api-pages.html delete mode 100644 docs/zh-CN/1.1.3/api-pages/index.html delete mode 100644 docs/zh-CN/1.1.3/blog.html delete mode 100644 docs/zh-CN/1.1.3/blog/index.html delete mode 100644 docs/zh-CN/1.1.3/commands.html delete mode 100644 docs/zh-CN/1.1.3/commands/index.html delete mode 100644 docs/zh-CN/1.1.3/custom-pages.html delete mode 100644 docs/zh-CN/1.1.3/custom-pages/index.html delete mode 100644 docs/zh-CN/1.1.3/doc-markdown.html delete mode 100644 docs/zh-CN/1.1.3/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.1.3/installation.html delete mode 100644 docs/zh-CN/1.1.3/installation/index.html delete mode 100644 docs/zh-CN/1.1.3/navigation.html delete mode 100644 docs/zh-CN/1.1.3/navigation/index.html delete mode 100644 docs/zh-CN/1.1.3/publishing.html delete mode 100644 docs/zh-CN/1.1.3/publishing/index.html delete mode 100644 docs/zh-CN/1.1.3/search.html delete mode 100644 docs/zh-CN/1.1.3/search/index.html delete mode 100644 docs/zh-CN/1.1.3/site-config.html delete mode 100644 docs/zh-CN/1.1.3/site-config/index.html delete mode 100644 docs/zh-CN/1.1.3/site-creation.html delete mode 100644 docs/zh-CN/1.1.3/site-creation/index.html delete mode 100644 docs/zh-CN/1.1.3/site-preparation.html delete mode 100644 docs/zh-CN/1.1.3/site-preparation/index.html delete mode 100644 docs/zh-CN/1.1.3/translation.html delete mode 100644 docs/zh-CN/1.1.3/translation/index.html delete mode 100644 docs/zh-CN/1.1.3/versioning.html delete mode 100644 docs/zh-CN/1.1.3/versioning/index.html delete mode 100644 docs/zh-CN/1.1.4/api-pages.html delete mode 100644 docs/zh-CN/1.1.4/api-pages/index.html delete mode 100644 docs/zh-CN/1.1.4/blog.html delete mode 100644 docs/zh-CN/1.1.4/blog/index.html delete mode 100644 docs/zh-CN/1.1.4/commands.html delete mode 100644 docs/zh-CN/1.1.4/commands/index.html delete mode 100644 docs/zh-CN/1.1.4/custom-pages.html delete mode 100644 docs/zh-CN/1.1.4/custom-pages/index.html delete mode 100644 docs/zh-CN/1.1.4/doc-markdown.html delete mode 100644 docs/zh-CN/1.1.4/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.1.4/installation.html delete mode 100644 docs/zh-CN/1.1.4/installation/index.html delete mode 100644 docs/zh-CN/1.1.4/navigation.html delete mode 100644 docs/zh-CN/1.1.4/navigation/index.html delete mode 100644 docs/zh-CN/1.1.4/publishing.html delete mode 100644 docs/zh-CN/1.1.4/publishing/index.html delete mode 100644 docs/zh-CN/1.1.4/search.html delete mode 100644 docs/zh-CN/1.1.4/search/index.html delete mode 100644 docs/zh-CN/1.1.4/site-config.html delete mode 100644 docs/zh-CN/1.1.4/site-config/index.html delete mode 100644 docs/zh-CN/1.1.4/site-creation.html delete mode 100644 docs/zh-CN/1.1.4/site-creation/index.html delete mode 100644 docs/zh-CN/1.1.4/site-preparation.html delete mode 100644 docs/zh-CN/1.1.4/site-preparation/index.html delete mode 100644 docs/zh-CN/1.1.4/translation.html delete mode 100644 docs/zh-CN/1.1.4/translation/index.html delete mode 100644 docs/zh-CN/1.1.4/versioning.html delete mode 100644 docs/zh-CN/1.1.4/versioning/index.html delete mode 100644 docs/zh-CN/1.1.5/api-pages.html delete mode 100644 docs/zh-CN/1.1.5/api-pages/index.html delete mode 100644 docs/zh-CN/1.1.5/blog.html delete mode 100644 docs/zh-CN/1.1.5/blog/index.html delete mode 100644 docs/zh-CN/1.1.5/commands.html delete mode 100644 docs/zh-CN/1.1.5/commands/index.html delete mode 100644 docs/zh-CN/1.1.5/custom-pages.html delete mode 100644 docs/zh-CN/1.1.5/custom-pages/index.html delete mode 100644 docs/zh-CN/1.1.5/doc-markdown.html delete mode 100644 docs/zh-CN/1.1.5/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.1.5/installation.html delete mode 100644 docs/zh-CN/1.1.5/installation/index.html delete mode 100644 docs/zh-CN/1.1.5/navigation.html delete mode 100644 docs/zh-CN/1.1.5/navigation/index.html delete mode 100644 docs/zh-CN/1.1.5/publishing.html delete mode 100644 docs/zh-CN/1.1.5/publishing/index.html delete mode 100644 docs/zh-CN/1.1.5/search.html delete mode 100644 docs/zh-CN/1.1.5/search/index.html delete mode 100644 docs/zh-CN/1.1.5/site-config.html delete mode 100644 docs/zh-CN/1.1.5/site-config/index.html delete mode 100644 docs/zh-CN/1.1.5/site-creation.html delete mode 100644 docs/zh-CN/1.1.5/site-creation/index.html delete mode 100644 docs/zh-CN/1.1.5/site-preparation.html delete mode 100644 docs/zh-CN/1.1.5/site-preparation/index.html delete mode 100644 docs/zh-CN/1.1.5/translation.html delete mode 100644 docs/zh-CN/1.1.5/translation/index.html delete mode 100644 docs/zh-CN/1.1.5/versioning.html delete mode 100644 docs/zh-CN/1.1.5/versioning/index.html delete mode 100644 docs/zh-CN/1.2.0/api-pages.html delete mode 100644 docs/zh-CN/1.2.0/api-pages/index.html delete mode 100644 docs/zh-CN/1.2.0/blog.html delete mode 100644 docs/zh-CN/1.2.0/blog/index.html delete mode 100644 docs/zh-CN/1.2.0/commands.html delete mode 100644 docs/zh-CN/1.2.0/commands/index.html delete mode 100644 docs/zh-CN/1.2.0/custom-pages.html delete mode 100644 docs/zh-CN/1.2.0/custom-pages/index.html delete mode 100644 docs/zh-CN/1.2.0/doc-markdown.html delete mode 100644 docs/zh-CN/1.2.0/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.2.0/installation.html delete mode 100644 docs/zh-CN/1.2.0/installation/index.html delete mode 100644 docs/zh-CN/1.2.0/navigation.html delete mode 100644 docs/zh-CN/1.2.0/navigation/index.html delete mode 100644 docs/zh-CN/1.2.0/publishing.html delete mode 100644 docs/zh-CN/1.2.0/publishing/index.html delete mode 100644 docs/zh-CN/1.2.0/search.html delete mode 100644 docs/zh-CN/1.2.0/search/index.html delete mode 100644 docs/zh-CN/1.2.0/site-config.html delete mode 100644 docs/zh-CN/1.2.0/site-config/index.html delete mode 100644 docs/zh-CN/1.2.0/site-creation.html delete mode 100644 docs/zh-CN/1.2.0/site-creation/index.html delete mode 100644 docs/zh-CN/1.2.0/site-preparation.html delete mode 100644 docs/zh-CN/1.2.0/site-preparation/index.html delete mode 100644 docs/zh-CN/1.2.0/translation.html delete mode 100644 docs/zh-CN/1.2.0/translation/index.html delete mode 100644 docs/zh-CN/1.2.0/versioning.html delete mode 100644 docs/zh-CN/1.2.0/versioning/index.html delete mode 100644 docs/zh-CN/1.2.1/api-pages.html delete mode 100644 docs/zh-CN/1.2.1/api-pages/index.html delete mode 100644 docs/zh-CN/1.2.1/blog.html delete mode 100644 docs/zh-CN/1.2.1/blog/index.html delete mode 100644 docs/zh-CN/1.2.1/commands.html delete mode 100644 docs/zh-CN/1.2.1/commands/index.html delete mode 100644 docs/zh-CN/1.2.1/custom-pages.html delete mode 100644 docs/zh-CN/1.2.1/custom-pages/index.html delete mode 100644 docs/zh-CN/1.2.1/doc-markdown.html delete mode 100644 docs/zh-CN/1.2.1/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.2.1/installation.html delete mode 100644 docs/zh-CN/1.2.1/installation/index.html delete mode 100644 docs/zh-CN/1.2.1/navigation.html delete mode 100644 docs/zh-CN/1.2.1/navigation/index.html delete mode 100644 docs/zh-CN/1.2.1/publishing.html delete mode 100644 docs/zh-CN/1.2.1/publishing/index.html delete mode 100644 docs/zh-CN/1.2.1/search.html delete mode 100644 docs/zh-CN/1.2.1/search/index.html delete mode 100644 docs/zh-CN/1.2.1/site-config.html delete mode 100644 docs/zh-CN/1.2.1/site-config/index.html delete mode 100644 docs/zh-CN/1.2.1/site-creation.html delete mode 100644 docs/zh-CN/1.2.1/site-creation/index.html delete mode 100644 docs/zh-CN/1.2.1/site-preparation.html delete mode 100644 docs/zh-CN/1.2.1/site-preparation/index.html delete mode 100644 docs/zh-CN/1.2.1/translation.html delete mode 100644 docs/zh-CN/1.2.1/translation/index.html delete mode 100644 docs/zh-CN/1.2.1/versioning.html delete mode 100644 docs/zh-CN/1.2.1/versioning/index.html delete mode 100644 docs/zh-CN/1.3.0/adding-blog.html delete mode 100644 docs/zh-CN/1.3.0/adding-blog/index.html delete mode 100644 docs/zh-CN/1.3.0/api-pages.html delete mode 100644 docs/zh-CN/1.3.0/api-pages/index.html delete mode 100644 docs/zh-CN/1.3.0/blog.html delete mode 100644 docs/zh-CN/1.3.0/blog/index.html delete mode 100644 docs/zh-CN/1.3.0/commands.html delete mode 100644 docs/zh-CN/1.3.0/commands/index.html delete mode 100644 docs/zh-CN/1.3.0/custom-pages.html delete mode 100644 docs/zh-CN/1.3.0/custom-pages/index.html delete mode 100644 docs/zh-CN/1.3.0/doc-markdown.html delete mode 100644 docs/zh-CN/1.3.0/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.3.0/installation.html delete mode 100644 docs/zh-CN/1.3.0/installation/index.html delete mode 100644 docs/zh-CN/1.3.0/navigation.html delete mode 100644 docs/zh-CN/1.3.0/navigation/index.html delete mode 100644 docs/zh-CN/1.3.0/publishing.html delete mode 100644 docs/zh-CN/1.3.0/publishing/index.html delete mode 100644 docs/zh-CN/1.3.0/search.html delete mode 100644 docs/zh-CN/1.3.0/search/index.html delete mode 100644 docs/zh-CN/1.3.0/site-config.html delete mode 100644 docs/zh-CN/1.3.0/site-config/index.html delete mode 100644 docs/zh-CN/1.3.0/site-creation.html delete mode 100644 docs/zh-CN/1.3.0/site-creation/index.html delete mode 100644 docs/zh-CN/1.3.0/site-preparation.html delete mode 100644 docs/zh-CN/1.3.0/site-preparation/index.html delete mode 100644 docs/zh-CN/1.3.0/translation.html delete mode 100644 docs/zh-CN/1.3.0/translation/index.html delete mode 100644 docs/zh-CN/1.3.0/versioning.html delete mode 100644 docs/zh-CN/1.3.0/versioning/index.html delete mode 100644 docs/zh-CN/1.3.1/adding-blog.html delete mode 100644 docs/zh-CN/1.3.1/adding-blog/index.html delete mode 100644 docs/zh-CN/1.3.1/api-pages.html delete mode 100644 docs/zh-CN/1.3.1/api-pages/index.html delete mode 100644 docs/zh-CN/1.3.1/blog.html delete mode 100644 docs/zh-CN/1.3.1/blog/index.html delete mode 100644 docs/zh-CN/1.3.1/commands.html delete mode 100644 docs/zh-CN/1.3.1/commands/index.html delete mode 100644 docs/zh-CN/1.3.1/custom-pages.html delete mode 100644 docs/zh-CN/1.3.1/custom-pages/index.html delete mode 100644 docs/zh-CN/1.3.1/doc-markdown.html delete mode 100644 docs/zh-CN/1.3.1/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.3.1/installation.html delete mode 100644 docs/zh-CN/1.3.1/installation/index.html delete mode 100644 docs/zh-CN/1.3.1/navigation.html delete mode 100644 docs/zh-CN/1.3.1/navigation/index.html delete mode 100644 docs/zh-CN/1.3.1/publishing.html delete mode 100644 docs/zh-CN/1.3.1/publishing/index.html delete mode 100644 docs/zh-CN/1.3.1/search.html delete mode 100644 docs/zh-CN/1.3.1/search/index.html delete mode 100644 docs/zh-CN/1.3.1/site-config.html delete mode 100644 docs/zh-CN/1.3.1/site-config/index.html delete mode 100644 docs/zh-CN/1.3.1/site-creation.html delete mode 100644 docs/zh-CN/1.3.1/site-creation/index.html delete mode 100644 docs/zh-CN/1.3.1/site-preparation.html delete mode 100644 docs/zh-CN/1.3.1/site-preparation/index.html delete mode 100644 docs/zh-CN/1.3.1/translation.html delete mode 100644 docs/zh-CN/1.3.1/translation/index.html delete mode 100644 docs/zh-CN/1.3.1/versioning.html delete mode 100644 docs/zh-CN/1.3.1/versioning/index.html delete mode 100644 docs/zh-CN/1.3.2/adding-blog.html delete mode 100644 docs/zh-CN/1.3.2/adding-blog/index.html delete mode 100644 docs/zh-CN/1.3.2/api-pages.html delete mode 100644 docs/zh-CN/1.3.2/api-pages/index.html delete mode 100644 docs/zh-CN/1.3.2/blog.html delete mode 100644 docs/zh-CN/1.3.2/blog/index.html delete mode 100644 docs/zh-CN/1.3.2/commands.html delete mode 100644 docs/zh-CN/1.3.2/commands/index.html delete mode 100644 docs/zh-CN/1.3.2/custom-pages.html delete mode 100644 docs/zh-CN/1.3.2/custom-pages/index.html delete mode 100644 docs/zh-CN/1.3.2/doc-markdown.html delete mode 100644 docs/zh-CN/1.3.2/doc-markdown/index.html delete mode 100644 docs/zh-CN/1.3.2/installation.html delete mode 100644 docs/zh-CN/1.3.2/installation/index.html delete mode 100644 docs/zh-CN/1.3.2/navigation.html delete mode 100644 docs/zh-CN/1.3.2/navigation/index.html delete mode 100644 docs/zh-CN/1.3.2/publishing.html delete mode 100644 docs/zh-CN/1.3.2/publishing/index.html delete mode 100644 docs/zh-CN/1.3.2/search.html delete mode 100644 docs/zh-CN/1.3.2/search/index.html delete mode 100644 docs/zh-CN/1.3.2/site-config.html delete mode 100644 docs/zh-CN/1.3.2/site-config/index.html delete mode 100644 docs/zh-CN/1.3.2/site-creation.html delete mode 100644 docs/zh-CN/1.3.2/site-creation/index.html delete mode 100644 docs/zh-CN/1.3.2/site-preparation.html delete mode 100644 docs/zh-CN/1.3.2/site-preparation/index.html delete mode 100644 docs/zh-CN/1.3.2/translation.html delete mode 100644 docs/zh-CN/1.3.2/translation/index.html delete mode 100644 docs/zh-CN/1.3.2/versioning.html delete mode 100644 docs/zh-CN/1.3.2/versioning/index.html delete mode 100644 docs/zh-CN/adding-blog.html delete mode 100644 docs/zh-CN/adding-blog/index.html delete mode 100644 docs/zh-CN/api-pages.html delete mode 100644 docs/zh-CN/api-pages/index.html delete mode 100644 docs/zh-CN/blog.html delete mode 100644 docs/zh-CN/blog/index.html delete mode 100644 docs/zh-CN/commands.html delete mode 100644 docs/zh-CN/commands/index.html delete mode 100644 docs/zh-CN/custom-pages.html delete mode 100644 docs/zh-CN/custom-pages/index.html delete mode 100644 docs/zh-CN/doc-markdown.html delete mode 100644 docs/zh-CN/doc-markdown/index.html delete mode 100644 docs/zh-CN/installation.html delete mode 100644 docs/zh-CN/installation/index.html delete mode 100644 docs/zh-CN/navigation.html delete mode 100644 docs/zh-CN/navigation/index.html delete mode 100644 docs/zh-CN/next/adding-blog.html delete mode 100644 docs/zh-CN/next/adding-blog/index.html delete mode 100644 docs/zh-CN/next/api-pages.html delete mode 100644 docs/zh-CN/next/api-pages/index.html delete mode 100644 docs/zh-CN/next/commands.html delete mode 100644 docs/zh-CN/next/commands/index.html delete mode 100644 docs/zh-CN/next/custom-pages.html delete mode 100644 docs/zh-CN/next/custom-pages/index.html delete mode 100644 docs/zh-CN/next/doc-markdown.html delete mode 100644 docs/zh-CN/next/doc-markdown/index.html delete mode 100644 docs/zh-CN/next/docker.html delete mode 100644 docs/zh-CN/next/docker/index.html delete mode 100644 docs/zh-CN/next/installation.html delete mode 100644 docs/zh-CN/next/installation/index.html delete mode 100644 docs/zh-CN/next/navigation.html delete mode 100644 docs/zh-CN/next/navigation/index.html delete mode 100644 docs/zh-CN/next/publishing.html delete mode 100644 docs/zh-CN/next/publishing/index.html delete mode 100644 docs/zh-CN/next/search.html delete mode 100644 docs/zh-CN/next/search/index.html delete mode 100644 docs/zh-CN/next/site-config.html delete mode 100644 docs/zh-CN/next/site-config/index.html delete mode 100644 docs/zh-CN/next/site-creation.html delete mode 100644 docs/zh-CN/next/site-creation/index.html delete mode 100644 docs/zh-CN/next/site-preparation.html delete mode 100644 docs/zh-CN/next/site-preparation/index.html delete mode 100644 docs/zh-CN/next/translation.html delete mode 100644 docs/zh-CN/next/translation/index.html delete mode 100644 docs/zh-CN/next/versioning.html delete mode 100644 docs/zh-CN/next/versioning/index.html delete mode 100644 docs/zh-CN/publishing.html delete mode 100644 docs/zh-CN/publishing/index.html delete mode 100644 docs/zh-CN/search.html delete mode 100644 docs/zh-CN/search/index.html delete mode 100644 docs/zh-CN/site-config.html delete mode 100644 docs/zh-CN/site-config/index.html delete mode 100644 docs/zh-CN/site-creation.html delete mode 100644 docs/zh-CN/site-creation/index.html delete mode 100644 docs/zh-CN/site-preparation.html delete mode 100644 docs/zh-CN/site-preparation/index.html delete mode 100644 docs/zh-CN/translation.html delete mode 100644 docs/zh-CN/translation/index.html delete mode 100644 docs/zh-CN/versioning.html delete mode 100644 docs/zh-CN/versioning/index.html diff --git a/docs/zh-CN/1.0.11/api-pages.html b/docs/zh-CN/1.0.11/api-pages.html deleted file mode 100644 index bcc5e05b12..0000000000 --- a/docs/zh-CN/1.0.11/api-pages.html +++ /dev/null @@ -1,179 +0,0 @@ -Pages and Styles · Docusaurus

1.0.11

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

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

-

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

-

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

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

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

CompLibrary.Container

-

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

-

Props

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

Example

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

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

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

Content Object

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

Example

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

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

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p><translate>I like translations</translate></p>
-
-

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

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">Community</translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require("../../server/translate.js").translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

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

-

Styles

-

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

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/api-pages/index.html b/docs/zh-CN/1.0.11/api-pages/index.html deleted file mode 100644 index bcc5e05b12..0000000000 --- a/docs/zh-CN/1.0.11/api-pages/index.html +++ /dev/null @@ -1,179 +0,0 @@ -Pages and Styles · Docusaurus

1.0.11

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

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

-

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

-

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

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

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

CompLibrary.Container

-

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

-

Props

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

Example

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

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

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

Content Object

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

Example

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

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

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p><translate>I like translations</translate></p>
-
-

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

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">Community</translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require("../../server/translate.js").translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

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

-

Styles

-

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

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/blog.html b/docs/zh-CN/1.0.11/blog.html deleted file mode 100644 index bfcd7599f4..0000000000 --- a/docs/zh-CN/1.0.11/blog.html +++ /dev/null @@ -1,133 +0,0 @@ -Adding a Blog · Docusaurus

1.0.11

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

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

添加文章

-

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

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

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

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook ID that is used to extract the profile picture.
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

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

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

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

-

-标签

-

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

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/blog/index.html b/docs/zh-CN/1.0.11/blog/index.html deleted file mode 100644 index bfcd7599f4..0000000000 --- a/docs/zh-CN/1.0.11/blog/index.html +++ /dev/null @@ -1,133 +0,0 @@ -Adding a Blog · Docusaurus

1.0.11

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

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

添加文章

-

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

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

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

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook ID that is used to extract the profile picture.
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

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

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

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

-

-标签

-

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

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/commands.html b/docs/zh-CN/1.0.11/commands.html deleted file mode 100644 index ac2715ec02..0000000000 --- a/docs/zh-CN/1.0.11/commands.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.11

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

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

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

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

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

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

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

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

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

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

-

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

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

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

    -

    e.g.,

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

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

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

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

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

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

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

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

-
-

docusaurus-版本 <版本>

-

Alias: version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/commands/index.html b/docs/zh-CN/1.0.11/commands/index.html deleted file mode 100644 index ac2715ec02..0000000000 --- a/docs/zh-CN/1.0.11/commands/index.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.11

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

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

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

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

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

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

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

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

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

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

-

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

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

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

    -

    e.g.,

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

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

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

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

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

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

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

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

-
-

docusaurus-版本 <版本>

-

Alias: version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/custom-pages.html b/docs/zh-CN/1.0.11/custom-pages.html deleted file mode 100644 index c4f0ddd038..0000000000 --- a/docs/zh-CN/1.0.11/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.11

Translate

Custom Pages

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

-

自定义您的主页

-

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

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

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

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

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

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

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

-
-

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

-
-

自定义您的页脚

-

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

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

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

-

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

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/custom-pages/index.html b/docs/zh-CN/1.0.11/custom-pages/index.html deleted file mode 100644 index c4f0ddd038..0000000000 --- a/docs/zh-CN/1.0.11/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.11

Translate

Custom Pages

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

-

自定义您的主页

-

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

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

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

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

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

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

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

-
-

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

-
-

自定义您的页脚

-

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

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

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

-

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

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/doc-markdown.html b/docs/zh-CN/1.0.11/doc-markdown.html deleted file mode 100644 index 1c109da16e..0000000000 --- a/docs/zh-CN/1.0.11/doc-markdown.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.11

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

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

-

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

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

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

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

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

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

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

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

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

这将会把页面带去这些功能的目录：

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

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

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

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/doc-markdown/index.html b/docs/zh-CN/1.0.11/doc-markdown/index.html deleted file mode 100644 index 1c109da16e..0000000000 --- a/docs/zh-CN/1.0.11/doc-markdown/index.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.11

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

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

-

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

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

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

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

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

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

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

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

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

这将会把页面带去这些功能的目录：

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

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

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

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/installation.html b/docs/zh-CN/1.0.11/installation.html deleted file mode 100644 index 54a1843077..0000000000 --- a/docs/zh-CN/1.0.11/installation.html +++ /dev/null @@ -1,114 +0,0 @@ -Installation · Docusaurus

1.0.11

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

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

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

    4. -

  4. docusaurus-init

    5. -
-
-

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

-
-

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

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

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

-
-

验证安装

-

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

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/installation/index.html b/docs/zh-CN/1.0.11/installation/index.html deleted file mode 100644 index 54a1843077..0000000000 --- a/docs/zh-CN/1.0.11/installation/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Installation · Docusaurus

1.0.11

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

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

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

    4. -

  4. docusaurus-init

    5. -
-
-

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

-
-

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

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

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

-
-

验证安装

-

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

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/navigation.html b/docs/zh-CN/1.0.11/navigation.html deleted file mode 100644 index 3d62f3581f..0000000000 --- a/docs/zh-CN/1.0.11/navigation.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.11

Translate

Navigation and Sidebars

Referencing Site Documents

-

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

-

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

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

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

-
-

How Documents are Linked

-

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

-

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

-

Suppose you add this to your document:

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

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

-
-

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

-
-

Adding Documents to a Sidebar

-

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

-
-

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

-
-

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

-
-

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

-
-

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

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

或者您也可以在边栏中创建一个新类别:

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

Adding New Sidebars

-

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

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

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

-

Additions to the Site Navigation Bar

-

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

-

Adding Documents

-

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

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

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

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

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

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

-

Adding External Links

-

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

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

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

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

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

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

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

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

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

Active Links In Site Navigation Bar

-

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

-
-

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

-
-

The siteNavGroupActive class will be added to these links:

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

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

-

Secondary On-Page Navigation

-

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

-
onPageNav: 'separate',
-
-

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

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/navigation/index.html b/docs/zh-CN/1.0.11/navigation/index.html deleted file mode 100644 index 3d62f3581f..0000000000 --- a/docs/zh-CN/1.0.11/navigation/index.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.11

Translate

Navigation and Sidebars

Referencing Site Documents

-

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

-

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

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

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

-
-

How Documents are Linked

-

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

-

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

-

Suppose you add this to your document:

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

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

-
-

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

-
-

Adding Documents to a Sidebar

-

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

-
-

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

-
-

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

-
-

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

-
-

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

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

或者您也可以在边栏中创建一个新类别:

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

Adding New Sidebars

-

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

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

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

-

Additions to the Site Navigation Bar

-

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

-

Adding Documents

-

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

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

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

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

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

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

-

Adding External Links

-

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

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

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

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

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

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

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

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

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

Active Links In Site Navigation Bar

-

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

-
-

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

-
-

The siteNavGroupActive class will be added to these links:

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

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

-

Secondary On-Page Navigation

-

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

-
onPageNav: 'separate',
-
-

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

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/publishing.html b/docs/zh-CN/1.0.11/publishing.html deleted file mode 100644 index 7743a767f9..0000000000 --- a/docs/zh-CN/1.0.11/publishing.html +++ /dev/null @@ -1,189 +0,0 @@ -Publishing your site · Docusaurus

1.0.11

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

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

-

构建静态 HTML 页

-

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

-
-

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

-
-

Using GitHub Pages

-

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

-

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

-
-

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

-
-

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

-

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

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

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

-

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

-
-

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

-
    -
  • GIT_USER: The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
    • -
-

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

-
    -

  • USE_SSH: If this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.

    • -

  • CURRENT_BRANCH: The branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.

    • -
-

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

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

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

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

-
-

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

-

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

-

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

-

Automating Deployments Using Continuous Integration

-

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

-

Using Circle CI 2.0

-

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

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

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

-

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

-
-

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

-

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

-
-

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

-
-

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

-
-

Tips & Tricks

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/publishing/index.html b/docs/zh-CN/1.0.11/publishing/index.html deleted file mode 100644 index 7743a767f9..0000000000 --- a/docs/zh-CN/1.0.11/publishing/index.html +++ /dev/null @@ -1,189 +0,0 @@ -Publishing your site · Docusaurus

1.0.11

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

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

-

构建静态 HTML 页

-

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

-
-

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

-
-

Using GitHub Pages

-

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

-

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

-
-

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

-
-

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

-

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

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

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

-

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

-
-

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

-
    -
  • GIT_USER: The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
    • -
-

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

-
    -

  • USE_SSH: If this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.

    • -

  • CURRENT_BRANCH: The branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.

    • -
-

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

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

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

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

-
-

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

-

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

-

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

-

Automating Deployments Using Continuous Integration

-

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

-

Using Circle CI 2.0

-

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

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

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

-

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

-
-

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

-

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

-
-

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

-
-

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

-
-

Tips & Tricks

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/search.html b/docs/zh-CN/1.0.11/search.html deleted file mode 100644 index 73774047a3..0000000000 --- a/docs/zh-CN/1.0.11/search.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.11

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

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

Disabling the Search Bar

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/search/index.html b/docs/zh-CN/1.0.11/search/index.html deleted file mode 100644 index 73774047a3..0000000000 --- a/docs/zh-CN/1.0.11/search/index.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.11

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

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

Disabling the Search Bar

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/site-config.html b/docs/zh-CN/1.0.11/site-config.html deleted file mode 100644 index 9c0018bbf7..0000000000 --- a/docs/zh-CN/1.0.11/site-config.html +++ /dev/null @@ -1,235 +0,0 @@ -siteConfig.js · Docusaurus

1.0.11

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

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

-

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

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

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

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

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

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

-

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

-

facebookPixelId - Facebook Pixel ID to track page views.

-

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

-

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

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

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

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

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

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
-

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

-

ogImage - url for an Open Graph image. This image will show up when your site is shared on Facebook, Twitter and any other websites/apps where the Open Graph protocol is supported.

-

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

- -

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

-

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

-

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

-

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

-

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

-

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

-

users - The users array mentioned earlier.

-

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

-

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

-

Example siteConfig.js with all fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-// For github.io type URLS, you would combine the url and baseUrl like:
-// url: "https://reasonml.github.io",
-// baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-// For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-// users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true"
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/site-config/index.html b/docs/zh-CN/1.0.11/site-config/index.html deleted file mode 100644 index 9c0018bbf7..0000000000 --- a/docs/zh-CN/1.0.11/site-config/index.html +++ /dev/null @@ -1,235 +0,0 @@ -siteConfig.js · Docusaurus

1.0.11

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

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

-

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

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

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

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

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

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

-

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

-

facebookPixelId - Facebook Pixel ID to track page views.

-

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

-

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

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

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

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

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

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
-

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

-

ogImage - url for an Open Graph image. This image will show up when your site is shared on Facebook, Twitter and any other websites/apps where the Open Graph protocol is supported.

-

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

- -

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

-

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

-

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

-

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

-

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

-

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

-

users - The users array mentioned earlier.

-

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

-

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

-

Example siteConfig.js with all fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-// For github.io type URLS, you would combine the url and baseUrl like:
-// url: "https://reasonml.github.io",
-// baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-// For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-// users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true"
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/site-creation.html b/docs/zh-CN/1.0.11/site-creation.html deleted file mode 100644 index 2f94f99cb7..0000000000 --- a/docs/zh-CN/1.0.11/site-creation.html +++ /dev/null @@ -1,114 +0,0 @@ -Creating your site · Docusaurus

1.0.11

Translate

Creating your site

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

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

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

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

-
-

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

-
-

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

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

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

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
    7. -
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/site-creation/index.html b/docs/zh-CN/1.0.11/site-creation/index.html deleted file mode 100644 index 2f94f99cb7..0000000000 --- a/docs/zh-CN/1.0.11/site-creation/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Creating your site · Docusaurus

1.0.11

Translate

Creating your site

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

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

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

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

-
-

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

-
-

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

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

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

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
    7. -
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/site-preparation.html b/docs/zh-CN/1.0.11/site-preparation.html deleted file mode 100644 index bf04b11ac0..0000000000 --- a/docs/zh-CN/1.0.11/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.11

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

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

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

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/site-preparation/index.html b/docs/zh-CN/1.0.11/site-preparation/index.html deleted file mode 100644 index bf04b11ac0..0000000000 --- a/docs/zh-CN/1.0.11/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.11

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

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

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

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/translation.html b/docs/zh-CN/1.0.11/translation.html deleted file mode 100644 index ef9557bc6b..0000000000 --- a/docs/zh-CN/1.0.11/translation.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.11

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

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

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

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

-
-
    -

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

    • -

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

    • -
-

翻译现有文档

-

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

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

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

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

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

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

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

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

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

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

-

Markdown Files

-

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

-

Other Pages

-

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

-

Crowdin

-

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

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

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

-
-

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

-
-

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

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

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

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

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

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

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

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

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

-

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

-

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

-

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

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

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

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

-

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

-

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

-

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

-

Versioned Translations

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/translation/index.html b/docs/zh-CN/1.0.11/translation/index.html deleted file mode 100644 index ef9557bc6b..0000000000 --- a/docs/zh-CN/1.0.11/translation/index.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.11

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

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

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

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

-
-
    -

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

    • -

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

    • -
-

翻译现有文档

-

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

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

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

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

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

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

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

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

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

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

-

Markdown Files

-

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

-

Other Pages

-

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

-

Crowdin

-

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

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

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

-
-

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

-
-

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

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

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

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

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

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

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

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

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

-

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

-

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

-

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

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

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

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

-

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

-

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

-

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

-

Versioned Translations

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/versioning.html b/docs/zh-CN/1.0.11/versioning.html deleted file mode 100644 index 5c87631ca1..0000000000 --- a/docs/zh-CN/1.0.11/versioning.html +++ /dev/null @@ -1,112 +0,0 @@ -Versioning · Docusaurus

1.0.11

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

Versioning Patterns

-

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

-

Storing Files for Each Version

-

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

-

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

-

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

-

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

-

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

-

Fallback Functionality

-

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

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.11/versioning/index.html b/docs/zh-CN/1.0.11/versioning/index.html deleted file mode 100644 index 5c87631ca1..0000000000 --- a/docs/zh-CN/1.0.11/versioning/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Versioning · Docusaurus

1.0.11

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

Versioning Patterns

-

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

-

Storing Files for Each Version

-

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

-

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

-

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

-

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

-

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

-

Fallback Functionality

-

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

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/api-pages.html b/docs/zh-CN/1.0.12/api-pages.html deleted file mode 100644 index 4e27be0242..0000000000 --- a/docs/zh-CN/1.0.12/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.12

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

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

-

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

-

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

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

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

CompLibrary.Container

-

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

-

Props

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

Example

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

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

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

Content Object

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

Example

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

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

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

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

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

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

-

Styles

-

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

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/api-pages/index.html b/docs/zh-CN/1.0.12/api-pages/index.html deleted file mode 100644 index 4e27be0242..0000000000 --- a/docs/zh-CN/1.0.12/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.12

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

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

-

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

-

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

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

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

CompLibrary.Container

-

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

-

Props

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

Example

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

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

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

Content Object

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

Example

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

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

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

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

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

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

-

Styles

-

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

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/blog.html b/docs/zh-CN/1.0.12/blog.html deleted file mode 100644 index fd4c2eb011..0000000000 --- a/docs/zh-CN/1.0.12/blog.html +++ /dev/null @@ -1,134 +0,0 @@ -Adding a Blog · Docusaurus

1.0.12

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

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

添加文章

-

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

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

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

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

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

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

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

-

-标签

-

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

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/blog/index.html b/docs/zh-CN/1.0.12/blog/index.html deleted file mode 100644 index fd4c2eb011..0000000000 --- a/docs/zh-CN/1.0.12/blog/index.html +++ /dev/null @@ -1,134 +0,0 @@ -Adding a Blog · Docusaurus

1.0.12

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

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

添加文章

-

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

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

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

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

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

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

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

-

-标签

-

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

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/commands.html b/docs/zh-CN/1.0.12/commands.html deleted file mode 100644 index 32c355b6c9..0000000000 --- a/docs/zh-CN/1.0.12/commands.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.12

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

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

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

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

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

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

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

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

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

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

-

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

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

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

    -

    e.g.,

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

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

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

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

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

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

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

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

-
-

docusaurus-版本 <版本>

-

Alias: version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/commands/index.html b/docs/zh-CN/1.0.12/commands/index.html deleted file mode 100644 index 32c355b6c9..0000000000 --- a/docs/zh-CN/1.0.12/commands/index.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.12

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

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

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

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

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

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

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

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

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

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

-

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

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

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

    -

    e.g.,

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

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

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

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

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

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

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

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

-
-

docusaurus-版本 <版本>

-

Alias: version

-

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

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/custom-pages.html b/docs/zh-CN/1.0.12/custom-pages.html deleted file mode 100644 index 7e84815bd0..0000000000 --- a/docs/zh-CN/1.0.12/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.12

Translate

Custom Pages

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

-

自定义您的主页

-

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

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

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

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

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

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

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

-
-

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

-
-

自定义您的页脚

-

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

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

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

-

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

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/custom-pages/index.html b/docs/zh-CN/1.0.12/custom-pages/index.html deleted file mode 100644 index 7e84815bd0..0000000000 --- a/docs/zh-CN/1.0.12/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.12

Translate

Custom Pages

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

-

自定义您的主页

-

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

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

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

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

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

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

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

-
-

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

-
-

自定义您的页脚

-

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

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

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

-

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

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/doc-markdown.html b/docs/zh-CN/1.0.12/doc-markdown.html deleted file mode 100644 index 18065b4a76..0000000000 --- a/docs/zh-CN/1.0.12/doc-markdown.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.12

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

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

-

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

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

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

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

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

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

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

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

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

这将会把页面带去这些功能的目录：

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

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

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

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/doc-markdown/index.html b/docs/zh-CN/1.0.12/doc-markdown/index.html deleted file mode 100644 index 18065b4a76..0000000000 --- a/docs/zh-CN/1.0.12/doc-markdown/index.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.12

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

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

-

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

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

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

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

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

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

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

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

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

这将会把页面带去这些功能的目录：

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

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

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

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/installation.html b/docs/zh-CN/1.0.12/installation.html deleted file mode 100644 index 23a58d71c7..0000000000 --- a/docs/zh-CN/1.0.12/installation.html +++ /dev/null @@ -1,114 +0,0 @@ -Installation · Docusaurus

1.0.12

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

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

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

    4. -

  4. docusaurus-init

    5. -
-
-

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

-
-

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

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

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

-
-

验证安装

-

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

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/installation/index.html b/docs/zh-CN/1.0.12/installation/index.html deleted file mode 100644 index 23a58d71c7..0000000000 --- a/docs/zh-CN/1.0.12/installation/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Installation · Docusaurus

1.0.12

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

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

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

    4. -

  4. docusaurus-init

    5. -
-
-

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

-
-

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

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

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

-
-

验证安装

-

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

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/navigation.html b/docs/zh-CN/1.0.12/navigation.html deleted file mode 100644 index 2ef27d272e..0000000000 --- a/docs/zh-CN/1.0.12/navigation.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.12

Translate

Navigation and Sidebars

Referencing Site Documents

-

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

-

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

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

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

-
-

How Documents are Linked

-

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

-

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

-

Suppose you add this to your document:

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

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

-
-

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

-
-

Adding Documents to a Sidebar

-

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

-
-

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

-
-

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

-
-

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

-
-

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

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

或者您也可以在边栏中创建一个新类别:

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

Adding New Sidebars

-

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

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

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

-

Additions to the Site Navigation Bar

-

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

-

Adding Documents

-

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

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

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

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

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

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

-

Adding External Links

-

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

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

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

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

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

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

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

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

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

Active Links In Site Navigation Bar

-

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

-
-

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

-
-

The siteNavGroupActive class will be added to these links:

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

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

-

Secondary On-Page Navigation

-

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

-
onPageNav: 'separate',
-
-

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

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/navigation/index.html b/docs/zh-CN/1.0.12/navigation/index.html deleted file mode 100644 index 2ef27d272e..0000000000 --- a/docs/zh-CN/1.0.12/navigation/index.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.12

Translate

Navigation and Sidebars

Referencing Site Documents

-

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

-

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

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

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

-
-

How Documents are Linked

-

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

-

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

-

Suppose you add this to your document:

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

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

-
-

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

-
-

Adding Documents to a Sidebar

-

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

-
-

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

-
-

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

-
-

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

-
-

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

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

或者您也可以在边栏中创建一个新类别:

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

Adding New Sidebars

-

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

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

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

-

Additions to the Site Navigation Bar

-

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

-

Adding Documents

-

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

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

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

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

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

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

-

Adding External Links

-

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

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

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

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

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

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

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

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

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

Active Links In Site Navigation Bar

-

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

-
-

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

-
-

The siteNavGroupActive class will be added to these links:

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

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

-

Secondary On-Page Navigation

-

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

-
onPageNav: 'separate',
-
-

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

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/publishing.html b/docs/zh-CN/1.0.12/publishing.html deleted file mode 100644 index 087a6a0ecf..0000000000 --- a/docs/zh-CN/1.0.12/publishing.html +++ /dev/null @@ -1,204 +0,0 @@ -Publishing your site · Docusaurus

1.0.12

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

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

-

构建静态 HTML 页

-

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

-
-

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

-
-

Using GitHub Pages

-

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

-

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

-
-

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

-
-

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

-

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

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

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

-

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

-
-

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

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

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

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

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

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

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

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

-
-

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

-

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

-

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

-

Automating Deployments Using Continuous Integration

-

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

-

Using Circle CI 2.0

-

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

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

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

-

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

-
-

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

-

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

-
-

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

-
-

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

-
-

Tips & Tricks

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/publishing/index.html b/docs/zh-CN/1.0.12/publishing/index.html deleted file mode 100644 index 087a6a0ecf..0000000000 --- a/docs/zh-CN/1.0.12/publishing/index.html +++ /dev/null @@ -1,204 +0,0 @@ -Publishing your site · Docusaurus

1.0.12

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

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

-

构建静态 HTML 页

-

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

-
-

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

-
-

Using GitHub Pages

-

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

-

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

-
-

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

-
-

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

-

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

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

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

-

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

-
-

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

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

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

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

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

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

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

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

-
-

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

-

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

-

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

-

Automating Deployments Using Continuous Integration

-

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

-

Using Circle CI 2.0

-

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

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

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

-

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

-
-

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

-

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

-
-

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

-
-

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

-
-

Tips & Tricks

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/search.html b/docs/zh-CN/1.0.12/search.html deleted file mode 100644 index c8a3b7a0d2..0000000000 --- a/docs/zh-CN/1.0.12/search.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.12

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

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

Disabling the Search Bar

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/search/index.html b/docs/zh-CN/1.0.12/search/index.html deleted file mode 100644 index c8a3b7a0d2..0000000000 --- a/docs/zh-CN/1.0.12/search/index.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.12

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

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

Disabling the Search Bar

-

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

-

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/site-config.html b/docs/zh-CN/1.0.12/site-config.html deleted file mode 100644 index ca11c00b15..0000000000 --- a/docs/zh-CN/1.0.12/site-config.html +++ /dev/null @@ -1,238 +0,0 @@ -siteConfig.js · Docusaurus

1.0.12

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

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

-

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

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

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

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

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

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

-

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

-

facebookPixelId - Facebook Pixel ID to track page views.

-

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

-

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

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

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

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

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

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
-

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

-

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

-

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

- -

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

-

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

-

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

-

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

-

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

-

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

-

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

-

users - The users array mentioned earlier.

-

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

-

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

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: "https://reasonml.github.io",
-  // baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true",
-  twitterImage: "img/docusaurus.png",
-  ogImage: "img/docusaurus.png",
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/site-config/index.html b/docs/zh-CN/1.0.12/site-config/index.html deleted file mode 100644 index ca11c00b15..0000000000 --- a/docs/zh-CN/1.0.12/site-config/index.html +++ /dev/null @@ -1,238 +0,0 @@ -siteConfig.js · Docusaurus

1.0.12

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

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

-

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

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

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

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

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

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

-

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

-

facebookPixelId - Facebook Pixel ID to track page views.

-

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

-

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

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

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

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

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

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
-

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

-

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

-

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

- -

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

-

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

-

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

-

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

-

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

-

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

-

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

-

users - The users array mentioned earlier.

-

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

-

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

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: "https://reasonml.github.io",
-  // baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true",
-  twitterImage: "img/docusaurus.png",
-  ogImage: "img/docusaurus.png",
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/site-creation.html b/docs/zh-CN/1.0.12/site-creation.html deleted file mode 100644 index d66d4d0dde..0000000000 --- a/docs/zh-CN/1.0.12/site-creation.html +++ /dev/null @@ -1,114 +0,0 @@ -Creating your site · Docusaurus

1.0.12

Translate

Creating your site

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

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

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

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

-
-

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

-
-

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

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

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

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
    7. -
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/site-creation/index.html b/docs/zh-CN/1.0.12/site-creation/index.html deleted file mode 100644 index d66d4d0dde..0000000000 --- a/docs/zh-CN/1.0.12/site-creation/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Creating your site · Docusaurus

1.0.12

Translate

Creating your site

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

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

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

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

-
-

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

-
-

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

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

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

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
    7. -
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/site-preparation.html b/docs/zh-CN/1.0.12/site-preparation.html deleted file mode 100644 index 55aa05922a..0000000000 --- a/docs/zh-CN/1.0.12/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.12

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

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

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

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/site-preparation/index.html b/docs/zh-CN/1.0.12/site-preparation/index.html deleted file mode 100644 index 55aa05922a..0000000000 --- a/docs/zh-CN/1.0.12/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.12

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

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

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

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/translation.html b/docs/zh-CN/1.0.12/translation.html deleted file mode 100644 index 446e45b870..0000000000 --- a/docs/zh-CN/1.0.12/translation.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.12

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

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

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

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

-
-
    -

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

    • -

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

    • -
-

翻译现有文档

-

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

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

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

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

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

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

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

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

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

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

-

Markdown Files

-

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

-

Other Pages

-

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

-

Crowdin

-

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

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

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

-
-

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

-
-

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

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

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

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

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

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

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

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

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

-

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

-

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

-

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

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

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

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

-

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

-

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

-

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

-

Versioned Translations

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/translation/index.html b/docs/zh-CN/1.0.12/translation/index.html deleted file mode 100644 index 446e45b870..0000000000 --- a/docs/zh-CN/1.0.12/translation/index.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.12

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

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

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

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

-
-
    -

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

    • -

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

    • -
-

翻译现有文档

-

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

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

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

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

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

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

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

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

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

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

-

Markdown Files

-

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

-

Other Pages

-

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

-

Crowdin

-

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

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

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

-
-

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

-
-

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

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

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

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

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

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

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

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

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

-

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

-

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

-

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

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

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

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

-

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

-

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

-

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

-

Versioned Translations

-

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

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

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

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/versioning.html b/docs/zh-CN/1.0.12/versioning.html deleted file mode 100644 index f2dd713bb2..0000000000 --- a/docs/zh-CN/1.0.12/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.12

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

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

Versioning Patterns

-

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

-

Storing Files for Each Version

-

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

-

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

-

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

-

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

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.12/versioning/index.html b/docs/zh-CN/1.0.12/versioning/index.html deleted file mode 100644 index f2dd713bb2..0000000000 --- a/docs/zh-CN/1.0.12/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.12

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/api-pages.html b/docs/zh-CN/1.0.13/api-pages.html deleted file mode 100644 index d1913f7fca..0000000000 --- a/docs/zh-CN/1.0.13/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.13

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to "../../core/CompLibrary.js" to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path "../core/CompLibrary.js".

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, "process.cwd() + /core/mycomponent.js".

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding "static". For example, if the site's baseUrl is "/docusaurus/", an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/api-pages/index.html b/docs/zh-CN/1.0.13/api-pages/index.html deleted file mode 100644 index d1913f7fca..0000000000 --- a/docs/zh-CN/1.0.13/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.13

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to "../../core/CompLibrary.js" to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path "../core/CompLibrary.js".

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, "process.cwd() + /core/mycomponent.js".

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding "static". For example, if the site's baseUrl is "/docusaurus/", an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/blog.html b/docs/zh-CN/1.0.13/blog.html deleted file mode 100644 index 8ab5f51fa0..0000000000 --- a/docs/zh-CN/1.0.13/blog.html +++ /dev/null @@ -1,134 +0,0 @@ -Adding a Blog · Docusaurus

1.0.13

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    {blog: true, label: 'Blog'},
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/blog/index.html b/docs/zh-CN/1.0.13/blog/index.html deleted file mode 100644 index 8ab5f51fa0..0000000000 --- a/docs/zh-CN/1.0.13/blog/index.html +++ /dev/null @@ -1,134 +0,0 @@ -Adding a Blog · Docusaurus

1.0.13

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    {blog: true, label: 'Blog'},
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/commands.html b/docs/zh-CN/1.0.13/commands.html deleted file mode 100644 index d44420d57b..0000000000 --- a/docs/zh-CN/1.0.13/commands.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.13

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    e.g.,

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/commands/index.html b/docs/zh-CN/1.0.13/commands/index.html deleted file mode 100644 index d44420d57b..0000000000 --- a/docs/zh-CN/1.0.13/commands/index.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.13

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    e.g.,

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/custom-pages.html b/docs/zh-CN/1.0.13/custom-pages.html deleted file mode 100644 index dc7526db29..0000000000 --- a/docs/zh-CN/1.0.13/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.13

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│       └── index.js
-│       └── users.js
-│       └── help.js
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: "about-slash", label: "About/"},

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/custom-pages/index.html b/docs/zh-CN/1.0.13/custom-pages/index.html deleted file mode 100644 index dc7526db29..0000000000 --- a/docs/zh-CN/1.0.13/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.13

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│       └── index.js
-│       └── users.js
-│       └── help.js
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: "about-slash", label: "About/"},

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/doc-markdown.html b/docs/zh-CN/1.0.13/doc-markdown.html deleted file mode 100644 index 7434d71754..0000000000 --- a/docs/zh-CN/1.0.13/doc-markdown.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.13

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/doc-markdown/index.html b/docs/zh-CN/1.0.13/doc-markdown/index.html deleted file mode 100644 index 7434d71754..0000000000 --- a/docs/zh-CN/1.0.13/doc-markdown/index.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.13

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/installation.html b/docs/zh-CN/1.0.13/installation.html deleted file mode 100644 index aff2cae96d..0000000000 --- a/docs/zh-CN/1.0.13/installation.html +++ /dev/null @@ -1,114 +0,0 @@ -Installation · Docusaurus

1.0.13

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

    4. -

  4. docusaurus-init

    5. -
-
-

After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing npm list docusaurus. You can update to the latest version of Docusaurus by typing npm update.

-
-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

-
-

验证安装

-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/installation/index.html b/docs/zh-CN/1.0.13/installation/index.html deleted file mode 100644 index aff2cae96d..0000000000 --- a/docs/zh-CN/1.0.13/installation/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Installation · Docusaurus

1.0.13

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

    4. -

  4. docusaurus-init

    5. -
-
-

After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing npm list docusaurus. You can update to the latest version of Docusaurus by typing npm update.

-
-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

-
-

验证安装

-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/navigation.html b/docs/zh-CN/1.0.13/navigation.html deleted file mode 100644 index b37db5d721..0000000000 --- a/docs/zh-CN/1.0.13/navigation.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.13

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flatfile structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My *new content* here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    ...
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-  },
-  ...
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
headerLinks: [
-  ...
-  { doc: 'my-examples', label: 'Examples' },
-  ...
-],
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
headerLinks: [
-  ...
-  { page: 'help', label: 'Help' },
-  ...
-],
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
headerLinks: [
-  ...
-  { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-  ...
-],
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { search: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { languages: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
onPageNav: 'separate',
-
-

Currently, separate is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/navigation/index.html b/docs/zh-CN/1.0.13/navigation/index.html deleted file mode 100644 index b37db5d721..0000000000 --- a/docs/zh-CN/1.0.13/navigation/index.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.13

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flatfile structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My *new content* here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    ...
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-  },
-  ...
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
headerLinks: [
-  ...
-  { doc: 'my-examples', label: 'Examples' },
-  ...
-],
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
headerLinks: [
-  ...
-  { page: 'help', label: 'Help' },
-  ...
-],
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
headerLinks: [
-  ...
-  { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-  ...
-],
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { search: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { languages: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
onPageNav: 'separate',
-
-

Currently, separate is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/publishing.html b/docs/zh-CN/1.0.13/publishing.html deleted file mode 100644 index b7961532ca..0000000000 --- a/docs/zh-CN/1.0.13/publishing.html +++ /dev/null @@ -1,204 +0,0 @@ -Publishing your site · Docusaurus

1.0.13

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-
-

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only one circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:7.10
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/assets folder.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/publishing/index.html b/docs/zh-CN/1.0.13/publishing/index.html deleted file mode 100644 index b7961532ca..0000000000 --- a/docs/zh-CN/1.0.13/publishing/index.html +++ /dev/null @@ -1,204 +0,0 @@ -Publishing your site · Docusaurus

1.0.13

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-
-

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only one circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:7.10
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/assets folder.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/search.html b/docs/zh-CN/1.0.13/search.html deleted file mode 100644 index 30d218047d..0000000000 --- a/docs/zh-CN/1.0.13/search.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.13

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-}
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/search/index.html b/docs/zh-CN/1.0.13/search/index.html deleted file mode 100644 index 30d218047d..0000000000 --- a/docs/zh-CN/1.0.13/search/index.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.13

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-}
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/site-config.html b/docs/zh-CN/1.0.13/site-config.html deleted file mode 100644 index 7e24903e2e..0000000000 --- a/docs/zh-CN/1.0.13/site-config.html +++ /dev/null @@ -1,239 +0,0 @@ -siteConfig.js · Docusaurus

1.0.13

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    "Times New Roman",
-    "Serif"
-  ],
-  myOtherFont: [
-    "-apple-system",
-    "system-ui"
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: "https://reasonml.github.io",
-  // baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true",
-  twitterImage: "img/docusaurus.png",
-  ogImage: "img/docusaurus.png",
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/site-config/index.html b/docs/zh-CN/1.0.13/site-config/index.html deleted file mode 100644 index 7e24903e2e..0000000000 --- a/docs/zh-CN/1.0.13/site-config/index.html +++ /dev/null @@ -1,239 +0,0 @@ -siteConfig.js · Docusaurus

1.0.13

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    "Times New Roman",
-    "Serif"
-  ],
-  myOtherFont: [
-    "-apple-system",
-    "system-ui"
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: "https://reasonml.github.io",
-  // baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true",
-  twitterImage: "img/docusaurus.png",
-  ogImage: "img/docusaurus.png",
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/site-creation.html b/docs/zh-CN/1.0.13/site-creation.html deleted file mode 100644 index c18a2e2f1e..0000000000 --- a/docs/zh-CN/1.0.13/site-creation.html +++ /dev/null @@ -1,114 +0,0 @@ -Creating your site · Docusaurus

1.0.13

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
     ---
- id: intro
- title: Getting Started
- ---
- 
- My *new content* here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
    7. -
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/site-creation/index.html b/docs/zh-CN/1.0.13/site-creation/index.html deleted file mode 100644 index c18a2e2f1e..0000000000 --- a/docs/zh-CN/1.0.13/site-creation/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Creating your site · Docusaurus

1.0.13

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
     ---
- id: intro
- title: Getting Started
- ---
- 
- My *new content* here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
    7. -
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/site-preparation.html b/docs/zh-CN/1.0.13/site-preparation.html deleted file mode 100644 index 3623b007a9..0000000000 --- a/docs/zh-CN/1.0.13/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.13

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/site-preparation/index.html b/docs/zh-CN/1.0.13/site-preparation/index.html deleted file mode 100644 index 3623b007a9..0000000000 --- a/docs/zh-CN/1.0.13/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.13

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/translation.html b/docs/zh-CN/1.0.13/translation.html deleted file mode 100644 index d9fa2b03e7..0000000000 --- a/docs/zh-CN/1.0.13/translation.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.13

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require("../../server/translate.js").translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
...
-"scripts": {
-  "write-translations": "docusaurus-write-translations"
-},
-...
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/translation/index.html b/docs/zh-CN/1.0.13/translation/index.html deleted file mode 100644 index d9fa2b03e7..0000000000 --- a/docs/zh-CN/1.0.13/translation/index.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.13

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require("../../server/translate.js").translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
...
-"scripts": {
-  "write-translations": "docusaurus-write-translations"
-},
-...
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/versioning.html b/docs/zh-CN/1.0.13/versioning.html deleted file mode 100644 index 77e675b0e6..0000000000 --- a/docs/zh-CN/1.0.13/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.13

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.13/versioning/index.html b/docs/zh-CN/1.0.13/versioning/index.html deleted file mode 100644 index 77e675b0e6..0000000000 --- a/docs/zh-CN/1.0.13/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.13

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/api-pages.html b/docs/zh-CN/1.0.14/api-pages.html deleted file mode 100644 index 1f75c4121d..0000000000 --- a/docs/zh-CN/1.0.14/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.14

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to "../../core/CompLibrary.js" to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path "../core/CompLibrary.js".

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, "process.cwd() + /core/mycomponent.js".

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding "static". For example, if the site's baseUrl is "/docusaurus/", an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/api-pages/index.html b/docs/zh-CN/1.0.14/api-pages/index.html deleted file mode 100644 index 1f75c4121d..0000000000 --- a/docs/zh-CN/1.0.14/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.14

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

Urls for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to "../../core/CompLibrary.js" to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path "../core/CompLibrary.js".

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, "process.cwd() + /core/mycomponent.js".

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding "static". For example, if the site's baseUrl is "/docusaurus/", an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/blog.html b/docs/zh-CN/1.0.14/blog.html deleted file mode 100644 index 951f76d7b1..0000000000 --- a/docs/zh-CN/1.0.14/blog.html +++ /dev/null @@ -1,195 +0,0 @@ -Adding a Blog · Docusaurus

1.0.14

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    {blog: true, label: 'Blog'},
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. -

    - Create a file index.html in website/static/. -

    -
    2. -
    <li>
-  <p>
-    Place the contents of the template below into <code>website/static/index.html</code>
-  </p>
-</li>
-
-<li>
-  <p>
-    Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-  </p>
-</li>
-
-<li>
-  <p>
-    Delete the dynamic landing page <code>website/pages/en/index.js</code>
-  </p>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

-

- 

<!DOCTYPE HTML>
-<html lang="en-US">
-    <head>
-        <meta charset="UTF-8">
-        <meta http-equiv="refresh" content="0; url=blog/">
-        <script type="text/javascript">
-            window.location.href = "blog/"
-        </script>
-        <title>Title of Your Blog</title>
-    </head>
-    <body>
-        If you are not redirected automatically, follow this <a href='blog/'>link</a>.
-    </body>
-</html>
-

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/blog/index.html b/docs/zh-CN/1.0.14/blog/index.html deleted file mode 100644 index 951f76d7b1..0000000000 --- a/docs/zh-CN/1.0.14/blog/index.html +++ /dev/null @@ -1,195 +0,0 @@ -Adding a Blog · Docusaurus

1.0.14

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    {blog: true, label: 'Blog'},
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. -

    - Create a file index.html in website/static/. -

    -
    2. -
    <li>
-  <p>
-    Place the contents of the template below into <code>website/static/index.html</code>
-  </p>
-</li>
-
-<li>
-  <p>
-    Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-  </p>
-</li>
-
-<li>
-  <p>
-    Delete the dynamic landing page <code>website/pages/en/index.js</code>
-  </p>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

-

- 

<!DOCTYPE HTML>
-<html lang="en-US">
-    <head>
-        <meta charset="UTF-8">
-        <meta http-equiv="refresh" content="0; url=blog/">
-        <script type="text/javascript">
-            window.location.href = "blog/"
-        </script>
-        <title>Title of Your Blog</title>
-    </head>
-    <body>
-        If you are not redirected automatically, follow this <a href='blog/'>link</a>.
-    </body>
-</html>
-

← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/commands.html b/docs/zh-CN/1.0.14/commands.html deleted file mode 100644 index a7eb86470b..0000000000 --- a/docs/zh-CN/1.0.14/commands.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.14

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    e.g.,

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/commands/index.html b/docs/zh-CN/1.0.14/commands/index.html deleted file mode 100644 index a7eb86470b..0000000000 --- a/docs/zh-CN/1.0.14/commands/index.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.14

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    e.g.,

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/custom-pages.html b/docs/zh-CN/1.0.14/custom-pages.html deleted file mode 100644 index 076754fb88..0000000000 --- a/docs/zh-CN/1.0.14/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.14

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│       └── index.js
-│       └── users.js
-│       └── help.js
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: "about-slash", label: "About/"},

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/custom-pages/index.html b/docs/zh-CN/1.0.14/custom-pages/index.html deleted file mode 100644 index 076754fb88..0000000000 --- a/docs/zh-CN/1.0.14/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.14

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│       └── index.js
-│       └── users.js
-│       └── help.js
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: "about-slash", label: "About/"},

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require("react");
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/doc-markdown.html b/docs/zh-CN/1.0.14/doc-markdown.html deleted file mode 100644 index 55853aea1f..0000000000 --- a/docs/zh-CN/1.0.14/doc-markdown.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.14

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/doc-markdown/index.html b/docs/zh-CN/1.0.14/doc-markdown/index.html deleted file mode 100644 index 55853aea1f..0000000000 --- a/docs/zh-CN/1.0.14/doc-markdown/index.html +++ /dev/null @@ -1,176 +0,0 @@ -Markdown Features · Docusaurus

1.0.14

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
-    });
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/installation.html b/docs/zh-CN/1.0.14/installation.html deleted file mode 100644 index 4cc5698828..0000000000 --- a/docs/zh-CN/1.0.14/installation.html +++ /dev/null @@ -1,110 +0,0 @@ -Installation · Docusaurus

1.0.14

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init > If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    4. -
-
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/installation/index.html b/docs/zh-CN/1.0.14/installation/index.html deleted file mode 100644 index 4cc5698828..0000000000 --- a/docs/zh-CN/1.0.14/installation/index.html +++ /dev/null @@ -1,110 +0,0 @@ -Installation · Docusaurus

1.0.14

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init > If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    4. -
-
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/navigation.html b/docs/zh-CN/1.0.14/navigation.html deleted file mode 100644 index 7d756c77bc..0000000000 --- a/docs/zh-CN/1.0.14/navigation.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.14

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flatfile structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My *new content* here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    ...
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-  },
-  ...
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
headerLinks: [
-  ...
-  { doc: 'my-examples', label: 'Examples' },
-  ...
-],
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
headerLinks: [
-  ...
-  { page: 'help', label: 'Help' },
-  ...
-],
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
headerLinks: [
-  ...
-  { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-  ...
-],
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { search: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { languages: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
onPageNav: 'separate',
-
-

Currently, separate is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/navigation/index.html b/docs/zh-CN/1.0.14/navigation/index.html deleted file mode 100644 index 7d756c77bc..0000000000 --- a/docs/zh-CN/1.0.14/navigation/index.html +++ /dev/null @@ -1,191 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.14

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flatfile structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My *new content* here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    ...
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-  },
-  ...
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
headerLinks: [
-  ...
-  { doc: 'my-examples', label: 'Examples' },
-  ...
-],
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
headerLinks: [
-  ...
-  { page: 'help', label: 'Help' },
-  ...
-],
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
headerLinks: [
-  ...
-  { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-  ...
-],
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { search: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { languages: true },
-  { doc: 'bar', label: 'Bar' },
-],
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
onPageNav: 'separate',
-
-

Currently, separate is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/publishing.html b/docs/zh-CN/1.0.14/publishing.html deleted file mode 100644 index 84276262e8..0000000000 --- a/docs/zh-CN/1.0.14/publishing.html +++ /dev/null @@ -1,225 +0,0 @@ -Publishing your site · Docusaurus

1.0.14

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only one circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:7.10
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/assets folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -
  1. Select New site from Git
    2. -
  2. Connect to your preferred Git provider.
    3. -
  3. Select the branch to deploy. Default is master
    4. -
  4. Configure your build steps:
    5. -
-
    -
  • For your build command enter: cd website; npm install; npm run build;
    • -
  • For publish directory: build/<projectName> (use the projectName from your siteConfig)
    • -
-
    -
  1. 单击 ** 部署站点 **
    2. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/publishing/index.html b/docs/zh-CN/1.0.14/publishing/index.html deleted file mode 100644 index 84276262e8..0000000000 --- a/docs/zh-CN/1.0.14/publishing/index.html +++ /dev/null @@ -1,225 +0,0 @@ -Publishing your site · Docusaurus

1.0.14

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only one circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:7.10
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/assets folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -
  1. Select New site from Git
    2. -
  2. Connect to your preferred Git provider.
    3. -
  3. Select the branch to deploy. Default is master
    4. -
  4. Configure your build steps:
    5. -
-
    -
  • For your build command enter: cd website; npm install; npm run build;
    • -
  • For publish directory: build/<projectName> (use the projectName from your siteConfig)
    • -
-
    -
  1. 单击 ** 部署站点 **
    2. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/search.html b/docs/zh-CN/1.0.14/search.html deleted file mode 100644 index de19932075..0000000000 --- a/docs/zh-CN/1.0.14/search.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.14

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-}
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/search/index.html b/docs/zh-CN/1.0.14/search/index.html deleted file mode 100644 index de19932075..0000000000 --- a/docs/zh-CN/1.0.14/search/index.html +++ /dev/null @@ -1,110 +0,0 @@ -Enabling Search · Docusaurus

1.0.14

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.

-

启用搜索框

-

Enter your search-only API key and index name into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: "my-search-only-api-key-1234",
-    indexName: "my-index-name"
-  },
-  ...
-}
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {
-  ...
-  algolia: {
-    ...
-    algoliaOptions: {
-      facetFilters: [ "tags:VERSION" ],
-      hitsPerPage: 5
-    }
-  },
-}
-
-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar in between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-}
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/site-config.html b/docs/zh-CN/1.0.14/site-config.html deleted file mode 100644 index b3dc9b1f67..0000000000 --- a/docs/zh-CN/1.0.14/site-config.html +++ /dev/null @@ -1,239 +0,0 @@ -siteConfig.js · Docusaurus

1.0.14

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    "Times New Roman",
-    "Serif"
-  ],
-  myOtherFont: [
-    "-apple-system",
-    "system-ui"
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: "https://reasonml.github.io",
-  // baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true",
-  twitterImage: "img/docusaurus.png",
-  ogImage: "img/docusaurus.png",
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/site-config/index.html b/docs/zh-CN/1.0.14/site-config/index.html deleted file mode 100644 index b3dc9b1f67..0000000000 --- a/docs/zh-CN/1.0.14/site-config/index.html +++ /dev/null @@ -1,239 +0,0 @@ -siteConfig.js · Docusaurus

1.0.14

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: "docs/site"
-
-
customDocsPath: "website-docs"
-
-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    "Times New Roman",
-    "Serif"
-  ],
-  myOtherFont: [
-    "-apple-system",
-    "system-ui"
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: "User1",
-    image: "/test-site/img/docusaurus.svg",
-    infoLink: "https://www.example.com",
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://docusaurus.io",
-  baseUrl: "/",
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: "https://reasonml.github.io",
-  // baseUrl: "/reason-react/",
-  organizationName: "facebook",
-  projectName: "docusaurus",
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B"
-  },
-  editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ "https://docusaurus.io/slash.js" ],
-  stylesheets: [ "https://docusaurus.io/style.css" ],
-  facebookAppId: "1615782811974223",
-  facebookPixelId: "352490515235776",
-  twitter: "true",
-  twitterImage: "img/docusaurus.png",
-  ogImage: "img/docusaurus.png",
-};
-
-module.exports = siteConfig;
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/site-creation.html b/docs/zh-CN/1.0.14/site-creation.html deleted file mode 100644 index 8df03475d7..0000000000 --- a/docs/zh-CN/1.0.14/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.0.14

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
     ---
- id: intro
- title: Getting Started
- ---
- 
- My *new content* here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-    <head>
-        <meta charset="UTF-8">
-        <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-        <script type="text/javascript">
-            window.location.href = "docs/id-of-doc-to-land-on.html"
-        </script>
-        <title>Your Site Title Here</title>
-    </head>
-    <body>
-        If you are not redirected automatically, follow this <a href='docs/id-of-doc-to-land-on.html'>link</a>.
-    </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/site-creation/index.html b/docs/zh-CN/1.0.14/site-creation/index.html deleted file mode 100644 index 8df03475d7..0000000000 --- a/docs/zh-CN/1.0.14/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.0.14

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-└── website
-│   └── blog
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
     ---
- id: intro
- title: Getting Started
- ---
- 
- My *new content* here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
     cd website
- yarn run start # or `npm run start`
- # navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-    <head>
-        <meta charset="UTF-8">
-        <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-        <script type="text/javascript">
-            window.location.href = "docs/id-of-doc-to-land-on.html"
-        </script>
-        <title>Your Site Title Here</title>
-    </head>
-    <body>
-        If you are not redirected automatically, follow this <a href='docs/id-of-doc-to-land-on.html'>link</a>.
-    </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/site-preparation.html b/docs/zh-CN/1.0.14/site-preparation.html deleted file mode 100644 index 00eb085ee9..0000000000 --- a/docs/zh-CN/1.0.14/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.14

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/site-preparation/index.html b/docs/zh-CN/1.0.14/site-preparation/index.html deleted file mode 100644 index 00eb085ee9..0000000000 --- a/docs/zh-CN/1.0.14/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.14

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   └── doc1.md
-│   └── doc2.md
-│   └── doc3.md
-│   └── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-│   └── blog-examples-from-docusaurus
-│       └── 2016-03-11-blog-post.md
-│       └── 2017-04-10-blog-post-two.md
-│   └── core
-│       └── Footer.js
-│   └── node_modules
-│   └── package.json
-│   └── pages
-│   └── sidebars.json
-│   └── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/translation.html b/docs/zh-CN/1.0.14/translation.html deleted file mode 100644 index 8ded74248d..0000000000 --- a/docs/zh-CN/1.0.14/translation.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.14

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require("../../server/translate.js").translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
...
-"scripts": {
-  "write-translations": "docusaurus-write-translations"
-},
-...
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/translation/index.html b/docs/zh-CN/1.0.14/translation/index.html deleted file mode 100644 index 8ded74248d..0000000000 --- a/docs/zh-CN/1.0.14/translation/index.html +++ /dev/null @@ -1,241 +0,0 @@ -Translations & Localization · Docusaurus

1.0.14

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require("../../server/translate.js").translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
...
-"scripts": {
-  "write-translations": "docusaurus-write-translations"
-},
-...
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/versioning.html b/docs/zh-CN/1.0.14/versioning.html deleted file mode 100644 index 2538829877..0000000000 --- a/docs/zh-CN/1.0.14/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.14

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.14/versioning/index.html b/docs/zh-CN/1.0.14/versioning/index.html deleted file mode 100644 index 2538829877..0000000000 --- a/docs/zh-CN/1.0.14/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.14

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/api-pages.html b/docs/zh-CN/1.0.15/api-pages.html deleted file mode 100644 index 961bb071ae..0000000000 --- a/docs/zh-CN/1.0.15/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.15

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/api-pages/index.html b/docs/zh-CN/1.0.15/api-pages/index.html deleted file mode 100644 index 961bb071ae..0000000000 --- a/docs/zh-CN/1.0.15/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.0.15

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/blog.html b/docs/zh-CN/1.0.15/blog.html deleted file mode 100644 index 6bda038451..0000000000 --- a/docs/zh-CN/1.0.15/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.0.15

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/blog/index.html b/docs/zh-CN/1.0.15/blog/index.html deleted file mode 100644 index 6bda038451..0000000000 --- a/docs/zh-CN/1.0.15/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.0.15

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/commands.html b/docs/zh-CN/1.0.15/commands.html deleted file mode 100644 index 935fcd3949..0000000000 --- a/docs/zh-CN/1.0.15/commands.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.15

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    e.g.,

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/commands/index.html b/docs/zh-CN/1.0.15/commands/index.html deleted file mode 100644 index 935fcd3949..0000000000 --- a/docs/zh-CN/1.0.15/commands/index.html +++ /dev/null @@ -1,143 +0,0 @@ -CLI Commands · Docusaurus

1.0.15

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples [feature]

-

别名：examples

-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    e.g.,

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version <currentVersion> <newVersion>

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

-

See the Versioning guide to learn more.

-
-

docusaurus-start [--port <number>]

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/custom-pages.html b/docs/zh-CN/1.0.15/custom-pages.html deleted file mode 100644 index 4500706720..0000000000 --- a/docs/zh-CN/1.0.15/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.15

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/custom-pages/index.html b/docs/zh-CN/1.0.15/custom-pages/index.html deleted file mode 100644 index 4500706720..0000000000 --- a/docs/zh-CN/1.0.15/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.0.15

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/doc-markdown.html b/docs/zh-CN/1.0.15/doc-markdown.html deleted file mode 100644 index 6e092558d0..0000000000 --- a/docs/zh-CN/1.0.15/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.0.15

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/doc-markdown/index.html b/docs/zh-CN/1.0.15/doc-markdown/index.html deleted file mode 100644 index 6e092558d0..0000000000 --- a/docs/zh-CN/1.0.15/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.0.15

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/installation.html b/docs/zh-CN/1.0.15/installation.html deleted file mode 100644 index 5531d67ee1..0000000000 --- a/docs/zh-CN/1.0.15/installation.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.0.15

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/installation/index.html b/docs/zh-CN/1.0.15/installation/index.html deleted file mode 100644 index 5531d67ee1..0000000000 --- a/docs/zh-CN/1.0.15/installation/index.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.0.15

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/navigation.html b/docs/zh-CN/1.0.15/navigation.html deleted file mode 100644 index be6442f7ed..0000000000 --- a/docs/zh-CN/1.0.15/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.15

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/navigation/index.html b/docs/zh-CN/1.0.15/navigation/index.html deleted file mode 100644 index be6442f7ed..0000000000 --- a/docs/zh-CN/1.0.15/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.0.15

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/publishing.html b/docs/zh-CN/1.0.15/publishing.html deleted file mode 100644 index 79ec39dde4..0000000000 --- a/docs/zh-CN/1.0.15/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.0.15

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only one circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:7.10
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/publishing/index.html b/docs/zh-CN/1.0.15/publishing/index.html deleted file mode 100644 index 79ec39dde4..0000000000 --- a/docs/zh-CN/1.0.15/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.0.15

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only one circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:7.10
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/search.html b/docs/zh-CN/1.0.15/search.html deleted file mode 100644 index bc33b567ab..0000000000 --- a/docs/zh-CN/1.0.15/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.0.15

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/search/index.html b/docs/zh-CN/1.0.15/search/index.html deleted file mode 100644 index bc33b567ab..0000000000 --- a/docs/zh-CN/1.0.15/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.0.15

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/site-config.html b/docs/zh-CN/1.0.15/site-config.html deleted file mode 100644 index d587f5bdd3..0000000000 --- a/docs/zh-CN/1.0.15/site-config.html +++ /dev/null @@ -1,243 +0,0 @@ -siteConfig.js · Docusaurus

1.0.15

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site'
-
-
customDocsPath: 'website-docs'
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: 'doc1', label: 'Docs' },
-    { page: 'help', label: 'Help' },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B'
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink:
-    'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey:
-      '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github'
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ 'https://docusaurus.io/slash.js' ],
-  stylesheets: [ 'https://docusaurus.io/style.css' ],
-  facebookAppId: '1615782811974223',
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/site-config/index.html b/docs/zh-CN/1.0.15/site-config/index.html deleted file mode 100644 index d587f5bdd3..0000000000 --- a/docs/zh-CN/1.0.15/site-config/index.html +++ /dev/null @@ -1,243 +0,0 @@ -siteConfig.js · Docusaurus

1.0.15

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site'
-
-
customDocsPath: 'website-docs'
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true
-  }
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    { doc: 'doc1', label: 'Docs' },
-    { page: 'help', label: 'Help' },
-    { search: true },
-    { blog: true }
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B'
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink:
-    'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey:
-      '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github'
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default'
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
-        return '<div class="foo">bar</div>';
-      }
-    }
-  ],
-  scripts: [ 'https://docusaurus.io/slash.js' ],
-  stylesheets: [ 'https://docusaurus.io/style.css' ],
-  facebookAppId: '1615782811974223',
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/site-creation.html b/docs/zh-CN/1.0.15/site-creation.html deleted file mode 100644 index 3f18c75cbc..0000000000 --- a/docs/zh-CN/1.0.15/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.0.15

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/site-creation/index.html b/docs/zh-CN/1.0.15/site-creation/index.html deleted file mode 100644 index 3f18c75cbc..0000000000 --- a/docs/zh-CN/1.0.15/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.0.15

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/site-preparation.html b/docs/zh-CN/1.0.15/site-preparation.html deleted file mode 100644 index b5d939a980..0000000000 --- a/docs/zh-CN/1.0.15/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.15

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/site-preparation/index.html b/docs/zh-CN/1.0.15/site-preparation/index.html deleted file mode 100644 index b5d939a980..0000000000 --- a/docs/zh-CN/1.0.15/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.0.15

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/translation.html b/docs/zh-CN/1.0.15/translation.html deleted file mode 100644 index dcda0eb23d..0000000000 --- a/docs/zh-CN/1.0.15/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.0.15

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/translation/index.html b/docs/zh-CN/1.0.15/translation/index.html deleted file mode 100644 index dcda0eb23d..0000000000 --- a/docs/zh-CN/1.0.15/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.0.15

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/versioning.html b/docs/zh-CN/1.0.15/versioning.html deleted file mode 100644 index d5e50e810c..0000000000 --- a/docs/zh-CN/1.0.15/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.15

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.15/versioning/index.html b/docs/zh-CN/1.0.15/versioning/index.html deleted file mode 100644 index d5e50e810c..0000000000 --- a/docs/zh-CN/1.0.15/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.0.15

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/api-pages.html b/docs/zh-CN/1.1.0/api-pages.html deleted file mode 100644 index ae63bb36f5..0000000000 --- a/docs/zh-CN/1.1.0/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.0

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/api-pages/index.html b/docs/zh-CN/1.1.0/api-pages/index.html deleted file mode 100644 index ae63bb36f5..0000000000 --- a/docs/zh-CN/1.1.0/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.0

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/blog.html b/docs/zh-CN/1.1.0/blog.html deleted file mode 100644 index efd370e0b7..0000000000 --- a/docs/zh-CN/1.1.0/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.0

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/blog/index.html b/docs/zh-CN/1.1.0/blog/index.html deleted file mode 100644 index efd370e0b7..0000000000 --- a/docs/zh-CN/1.1.0/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.0

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/commands.html b/docs/zh-CN/1.1.0/commands.html deleted file mode 100644 index b66388ea49..0000000000 --- a/docs/zh-CN/1.1.0/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/commands/index.html b/docs/zh-CN/1.1.0/commands/index.html deleted file mode 100644 index b66388ea49..0000000000 --- a/docs/zh-CN/1.1.0/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/custom-pages.html b/docs/zh-CN/1.1.0/custom-pages.html deleted file mode 100644 index 9dc19a62ad..0000000000 --- a/docs/zh-CN/1.1.0/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/custom-pages/index.html b/docs/zh-CN/1.1.0/custom-pages/index.html deleted file mode 100644 index 9dc19a62ad..0000000000 --- a/docs/zh-CN/1.1.0/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/doc-markdown.html b/docs/zh-CN/1.1.0/doc-markdown.html deleted file mode 100644 index 3527ba6d29..0000000000 --- a/docs/zh-CN/1.1.0/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.0

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/doc-markdown/index.html b/docs/zh-CN/1.1.0/doc-markdown/index.html deleted file mode 100644 index 3527ba6d29..0000000000 --- a/docs/zh-CN/1.1.0/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.0

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/installation.html b/docs/zh-CN/1.1.0/installation.html deleted file mode 100644 index df85bd6277..0000000000 --- a/docs/zh-CN/1.1.0/installation.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.1.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/installation/index.html b/docs/zh-CN/1.1.0/installation/index.html deleted file mode 100644 index df85bd6277..0000000000 --- a/docs/zh-CN/1.1.0/installation/index.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.1.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/navigation.html b/docs/zh-CN/1.1.0/navigation.html deleted file mode 100644 index a228255314..0000000000 --- a/docs/zh-CN/1.1.0/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.0

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/navigation/index.html b/docs/zh-CN/1.1.0/navigation/index.html deleted file mode 100644 index a228255314..0000000000 --- a/docs/zh-CN/1.1.0/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.0

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/publishing.html b/docs/zh-CN/1.1.0/publishing.html deleted file mode 100644 index dbefb4fe89..0000000000 --- a/docs/zh-CN/1.1.0/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/publishing/index.html b/docs/zh-CN/1.1.0/publishing/index.html deleted file mode 100644 index dbefb4fe89..0000000000 --- a/docs/zh-CN/1.1.0/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/search.html b/docs/zh-CN/1.1.0/search.html deleted file mode 100644 index 8ca89b4bbd..0000000000 --- a/docs/zh-CN/1.1.0/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/search/index.html b/docs/zh-CN/1.1.0/search/index.html deleted file mode 100644 index 8ca89b4bbd..0000000000 --- a/docs/zh-CN/1.1.0/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/site-config.html b/docs/zh-CN/1.1.0/site-config.html deleted file mode 100644 index 193c31d484..0000000000 --- a/docs/zh-CN/1.1.0/site-config.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/site-config/index.html b/docs/zh-CN/1.1.0/site-config/index.html deleted file mode 100644 index 193c31d484..0000000000 --- a/docs/zh-CN/1.1.0/site-config/index.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/site-creation.html b/docs/zh-CN/1.1.0/site-creation.html deleted file mode 100644 index e3b1fdf861..0000000000 --- a/docs/zh-CN/1.1.0/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/site-creation/index.html b/docs/zh-CN/1.1.0/site-creation/index.html deleted file mode 100644 index e3b1fdf861..0000000000 --- a/docs/zh-CN/1.1.0/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/site-preparation.html b/docs/zh-CN/1.1.0/site-preparation.html deleted file mode 100644 index 7344053abe..0000000000 --- a/docs/zh-CN/1.1.0/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/site-preparation/index.html b/docs/zh-CN/1.1.0/site-preparation/index.html deleted file mode 100644 index 7344053abe..0000000000 --- a/docs/zh-CN/1.1.0/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/translation.html b/docs/zh-CN/1.1.0/translation.html deleted file mode 100644 index 9a8a42527b..0000000000 --- a/docs/zh-CN/1.1.0/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/translation/index.html b/docs/zh-CN/1.1.0/translation/index.html deleted file mode 100644 index 9a8a42527b..0000000000 --- a/docs/zh-CN/1.1.0/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/versioning.html b/docs/zh-CN/1.1.0/versioning.html deleted file mode 100644 index 3f98b772ed..0000000000 --- a/docs/zh-CN/1.1.0/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.0

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.0/versioning/index.html b/docs/zh-CN/1.1.0/versioning/index.html deleted file mode 100644 index 3f98b772ed..0000000000 --- a/docs/zh-CN/1.1.0/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.0

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/api-pages.html b/docs/zh-CN/1.1.1/api-pages.html deleted file mode 100644 index d20ba1dac3..0000000000 --- a/docs/zh-CN/1.1.1/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.1

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/api-pages/index.html b/docs/zh-CN/1.1.1/api-pages/index.html deleted file mode 100644 index d20ba1dac3..0000000000 --- a/docs/zh-CN/1.1.1/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.1

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/blog.html b/docs/zh-CN/1.1.1/blog.html deleted file mode 100644 index 53151387ac..0000000000 --- a/docs/zh-CN/1.1.1/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.1

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/blog/index.html b/docs/zh-CN/1.1.1/blog/index.html deleted file mode 100644 index 53151387ac..0000000000 --- a/docs/zh-CN/1.1.1/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.1

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/commands.html b/docs/zh-CN/1.1.1/commands.html deleted file mode 100644 index ea8958175e..0000000000 --- a/docs/zh-CN/1.1.1/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.1

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/commands/index.html b/docs/zh-CN/1.1.1/commands/index.html deleted file mode 100644 index ea8958175e..0000000000 --- a/docs/zh-CN/1.1.1/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.1

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/custom-pages.html b/docs/zh-CN/1.1.1/custom-pages.html deleted file mode 100644 index 9391f3faad..0000000000 --- a/docs/zh-CN/1.1.1/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.1

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/custom-pages/index.html b/docs/zh-CN/1.1.1/custom-pages/index.html deleted file mode 100644 index 9391f3faad..0000000000 --- a/docs/zh-CN/1.1.1/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.1

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/doc-markdown.html b/docs/zh-CN/1.1.1/doc-markdown.html deleted file mode 100644 index d63b810c59..0000000000 --- a/docs/zh-CN/1.1.1/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.1

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/doc-markdown/index.html b/docs/zh-CN/1.1.1/doc-markdown/index.html deleted file mode 100644 index d63b810c59..0000000000 --- a/docs/zh-CN/1.1.1/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.1

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/installation.html b/docs/zh-CN/1.1.1/installation.html deleted file mode 100644 index 46c5c1b77b..0000000000 --- a/docs/zh-CN/1.1.1/installation.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.1.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/installation/index.html b/docs/zh-CN/1.1.1/installation/index.html deleted file mode 100644 index 46c5c1b77b..0000000000 --- a/docs/zh-CN/1.1.1/installation/index.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.1.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/navigation.html b/docs/zh-CN/1.1.1/navigation.html deleted file mode 100644 index 0f7ec9be8b..0000000000 --- a/docs/zh-CN/1.1.1/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.1

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/navigation/index.html b/docs/zh-CN/1.1.1/navigation/index.html deleted file mode 100644 index 0f7ec9be8b..0000000000 --- a/docs/zh-CN/1.1.1/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.1

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/publishing.html b/docs/zh-CN/1.1.1/publishing.html deleted file mode 100644 index b6a3260345..0000000000 --- a/docs/zh-CN/1.1.1/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.1

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/publishing/index.html b/docs/zh-CN/1.1.1/publishing/index.html deleted file mode 100644 index b6a3260345..0000000000 --- a/docs/zh-CN/1.1.1/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.1

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/search.html b/docs/zh-CN/1.1.1/search.html deleted file mode 100644 index d1f01cfe4d..0000000000 --- a/docs/zh-CN/1.1.1/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.1

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/search/index.html b/docs/zh-CN/1.1.1/search/index.html deleted file mode 100644 index d1f01cfe4d..0000000000 --- a/docs/zh-CN/1.1.1/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.1

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/site-config.html b/docs/zh-CN/1.1.1/site-config.html deleted file mode 100644 index 7ef70e55f2..0000000000 --- a/docs/zh-CN/1.1.1/site-config.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.1

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/site-config/index.html b/docs/zh-CN/1.1.1/site-config/index.html deleted file mode 100644 index 7ef70e55f2..0000000000 --- a/docs/zh-CN/1.1.1/site-config/index.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.1

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/site-creation.html b/docs/zh-CN/1.1.1/site-creation.html deleted file mode 100644 index 92f91b2e5a..0000000000 --- a/docs/zh-CN/1.1.1/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.1

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/site-creation/index.html b/docs/zh-CN/1.1.1/site-creation/index.html deleted file mode 100644 index 92f91b2e5a..0000000000 --- a/docs/zh-CN/1.1.1/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.1

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/site-preparation.html b/docs/zh-CN/1.1.1/site-preparation.html deleted file mode 100644 index 55fcd61bec..0000000000 --- a/docs/zh-CN/1.1.1/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.1

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/site-preparation/index.html b/docs/zh-CN/1.1.1/site-preparation/index.html deleted file mode 100644 index 55fcd61bec..0000000000 --- a/docs/zh-CN/1.1.1/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.1

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/translation.html b/docs/zh-CN/1.1.1/translation.html deleted file mode 100644 index bfdfb9304d..0000000000 --- a/docs/zh-CN/1.1.1/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.1

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/translation/index.html b/docs/zh-CN/1.1.1/translation/index.html deleted file mode 100644 index bfdfb9304d..0000000000 --- a/docs/zh-CN/1.1.1/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.1

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/versioning.html b/docs/zh-CN/1.1.1/versioning.html deleted file mode 100644 index 5aabad6ecd..0000000000 --- a/docs/zh-CN/1.1.1/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.1

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.1/versioning/index.html b/docs/zh-CN/1.1.1/versioning/index.html deleted file mode 100644 index 5aabad6ecd..0000000000 --- a/docs/zh-CN/1.1.1/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.1

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/api-pages.html b/docs/zh-CN/1.1.2/api-pages.html deleted file mode 100644 index c54d800466..0000000000 --- a/docs/zh-CN/1.1.2/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.2

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/api-pages/index.html b/docs/zh-CN/1.1.2/api-pages/index.html deleted file mode 100644 index c54d800466..0000000000 --- a/docs/zh-CN/1.1.2/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.2

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/blog.html b/docs/zh-CN/1.1.2/blog.html deleted file mode 100644 index 361fe918d5..0000000000 --- a/docs/zh-CN/1.1.2/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.2

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/blog/index.html b/docs/zh-CN/1.1.2/blog/index.html deleted file mode 100644 index 361fe918d5..0000000000 --- a/docs/zh-CN/1.1.2/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.2

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/commands.html b/docs/zh-CN/1.1.2/commands.html deleted file mode 100644 index ceac137db8..0000000000 --- a/docs/zh-CN/1.1.2/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.2

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/commands/index.html b/docs/zh-CN/1.1.2/commands/index.html deleted file mode 100644 index ceac137db8..0000000000 --- a/docs/zh-CN/1.1.2/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.2

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/custom-pages.html b/docs/zh-CN/1.1.2/custom-pages.html deleted file mode 100644 index b0c84b7277..0000000000 --- a/docs/zh-CN/1.1.2/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.2

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/custom-pages/index.html b/docs/zh-CN/1.1.2/custom-pages/index.html deleted file mode 100644 index b0c84b7277..0000000000 --- a/docs/zh-CN/1.1.2/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.2

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/doc-markdown.html b/docs/zh-CN/1.1.2/doc-markdown.html deleted file mode 100644 index 3e118171ef..0000000000 --- a/docs/zh-CN/1.1.2/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.2

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/doc-markdown/index.html b/docs/zh-CN/1.1.2/doc-markdown/index.html deleted file mode 100644 index 3e118171ef..0000000000 --- a/docs/zh-CN/1.1.2/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.2

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/installation.html b/docs/zh-CN/1.1.2/installation.html deleted file mode 100644 index 6a86547dfa..0000000000 --- a/docs/zh-CN/1.1.2/installation.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.1.2

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/installation/index.html b/docs/zh-CN/1.1.2/installation/index.html deleted file mode 100644 index 6a86547dfa..0000000000 --- a/docs/zh-CN/1.1.2/installation/index.html +++ /dev/null @@ -1,111 +0,0 @@ -Installation · Docusaurus

1.1.2

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/navigation.html b/docs/zh-CN/1.1.2/navigation.html deleted file mode 100644 index 6e7c00d1bc..0000000000 --- a/docs/zh-CN/1.1.2/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.2

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/navigation/index.html b/docs/zh-CN/1.1.2/navigation/index.html deleted file mode 100644 index 6e7c00d1bc..0000000000 --- a/docs/zh-CN/1.1.2/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.2

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/publishing.html b/docs/zh-CN/1.1.2/publishing.html deleted file mode 100644 index fef63713b2..0000000000 --- a/docs/zh-CN/1.1.2/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.2

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/publishing/index.html b/docs/zh-CN/1.1.2/publishing/index.html deleted file mode 100644 index fef63713b2..0000000000 --- a/docs/zh-CN/1.1.2/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.2

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/search.html b/docs/zh-CN/1.1.2/search.html deleted file mode 100644 index a41f6e444a..0000000000 --- a/docs/zh-CN/1.1.2/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.2

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/search/index.html b/docs/zh-CN/1.1.2/search/index.html deleted file mode 100644 index a41f6e444a..0000000000 --- a/docs/zh-CN/1.1.2/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.2

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/site-config.html b/docs/zh-CN/1.1.2/site-config.html deleted file mode 100644 index 482f8c394c..0000000000 --- a/docs/zh-CN/1.1.2/site-config.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.2

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/site-config/index.html b/docs/zh-CN/1.1.2/site-config/index.html deleted file mode 100644 index 482f8c394c..0000000000 --- a/docs/zh-CN/1.1.2/site-config/index.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.2

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/site-creation.html b/docs/zh-CN/1.1.2/site-creation.html deleted file mode 100644 index b86b053e69..0000000000 --- a/docs/zh-CN/1.1.2/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.2

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/site-creation/index.html b/docs/zh-CN/1.1.2/site-creation/index.html deleted file mode 100644 index b86b053e69..0000000000 --- a/docs/zh-CN/1.1.2/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.2

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/site-preparation.html b/docs/zh-CN/1.1.2/site-preparation.html deleted file mode 100644 index a3c3c91108..0000000000 --- a/docs/zh-CN/1.1.2/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.2

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/site-preparation/index.html b/docs/zh-CN/1.1.2/site-preparation/index.html deleted file mode 100644 index a3c3c91108..0000000000 --- a/docs/zh-CN/1.1.2/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.2

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/translation.html b/docs/zh-CN/1.1.2/translation.html deleted file mode 100644 index 903e4c052f..0000000000 --- a/docs/zh-CN/1.1.2/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.2

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/translation/index.html b/docs/zh-CN/1.1.2/translation/index.html deleted file mode 100644 index 903e4c052f..0000000000 --- a/docs/zh-CN/1.1.2/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.2

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/versioning.html b/docs/zh-CN/1.1.2/versioning.html deleted file mode 100644 index 7f0982d71a..0000000000 --- a/docs/zh-CN/1.1.2/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.2

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.2/versioning/index.html b/docs/zh-CN/1.1.2/versioning/index.html deleted file mode 100644 index 7f0982d71a..0000000000 --- a/docs/zh-CN/1.1.2/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.2

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/api-pages.html b/docs/zh-CN/1.1.3/api-pages.html deleted file mode 100644 index 459859b15a..0000000000 --- a/docs/zh-CN/1.1.3/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.3

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/api-pages/index.html b/docs/zh-CN/1.1.3/api-pages/index.html deleted file mode 100644 index 459859b15a..0000000000 --- a/docs/zh-CN/1.1.3/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.3

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/blog.html b/docs/zh-CN/1.1.3/blog.html deleted file mode 100644 index d8965e350d..0000000000 --- a/docs/zh-CN/1.1.3/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.3

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/blog/index.html b/docs/zh-CN/1.1.3/blog/index.html deleted file mode 100644 index d8965e350d..0000000000 --- a/docs/zh-CN/1.1.3/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.3

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/commands.html b/docs/zh-CN/1.1.3/commands.html deleted file mode 100644 index 463340ba2d..0000000000 --- a/docs/zh-CN/1.1.3/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.3

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/commands/index.html b/docs/zh-CN/1.1.3/commands/index.html deleted file mode 100644 index 463340ba2d..0000000000 --- a/docs/zh-CN/1.1.3/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.3

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/custom-pages.html b/docs/zh-CN/1.1.3/custom-pages.html deleted file mode 100644 index 55a9d9cd04..0000000000 --- a/docs/zh-CN/1.1.3/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/custom-pages/index.html b/docs/zh-CN/1.1.3/custom-pages/index.html deleted file mode 100644 index 55a9d9cd04..0000000000 --- a/docs/zh-CN/1.1.3/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/doc-markdown.html b/docs/zh-CN/1.1.3/doc-markdown.html deleted file mode 100644 index 0d6ba7265f..0000000000 --- a/docs/zh-CN/1.1.3/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.3

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/doc-markdown/index.html b/docs/zh-CN/1.1.3/doc-markdown/index.html deleted file mode 100644 index 0d6ba7265f..0000000000 --- a/docs/zh-CN/1.1.3/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.3

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/installation.html b/docs/zh-CN/1.1.3/installation.html deleted file mode 100644 index 54475349ce..0000000000 --- a/docs/zh-CN/1.1.3/installation.html +++ /dev/null @@ -1,116 +0,0 @@ -Installation · Docusaurus

1.1.3

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   └── 2017-04-10-blog-post-two.md
-    ├── core
-    │   └── Footer.js
-    ├── node_modules
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/installation/index.html b/docs/zh-CN/1.1.3/installation/index.html deleted file mode 100644 index 54475349ce..0000000000 --- a/docs/zh-CN/1.1.3/installation/index.html +++ /dev/null @@ -1,116 +0,0 @@ -Installation · Docusaurus

1.1.3

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   └── 2017-04-10-blog-post-two.md
-    ├── core
-    │   └── Footer.js
-    ├── node_modules
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/navigation.html b/docs/zh-CN/1.1.3/navigation.html deleted file mode 100644 index 1602af6553..0000000000 --- a/docs/zh-CN/1.1.3/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.3

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/navigation/index.html b/docs/zh-CN/1.1.3/navigation/index.html deleted file mode 100644 index 1602af6553..0000000000 --- a/docs/zh-CN/1.1.3/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.3

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/publishing.html b/docs/zh-CN/1.1.3/publishing.html deleted file mode 100644 index 21f5773c51..0000000000 --- a/docs/zh-CN/1.1.3/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.3

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/publishing/index.html b/docs/zh-CN/1.1.3/publishing/index.html deleted file mode 100644 index 21f5773c51..0000000000 --- a/docs/zh-CN/1.1.3/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.3

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/search.html b/docs/zh-CN/1.1.3/search.html deleted file mode 100644 index 7d2acc717a..0000000000 --- a/docs/zh-CN/1.1.3/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.3

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/search/index.html b/docs/zh-CN/1.1.3/search/index.html deleted file mode 100644 index 7d2acc717a..0000000000 --- a/docs/zh-CN/1.1.3/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.3

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/site-config.html b/docs/zh-CN/1.1.3/site-config.html deleted file mode 100644 index 7a9edb6f42..0000000000 --- a/docs/zh-CN/1.1.3/site-config.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.3

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/site-config/index.html b/docs/zh-CN/1.1.3/site-config/index.html deleted file mode 100644 index 7a9edb6f42..0000000000 --- a/docs/zh-CN/1.1.3/site-config/index.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.3

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/site-creation.html b/docs/zh-CN/1.1.3/site-creation.html deleted file mode 100644 index 84e52354a5..0000000000 --- a/docs/zh-CN/1.1.3/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.3

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/site-creation/index.html b/docs/zh-CN/1.1.3/site-creation/index.html deleted file mode 100644 index 84e52354a5..0000000000 --- a/docs/zh-CN/1.1.3/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.3

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/site-preparation.html b/docs/zh-CN/1.1.3/site-preparation.html deleted file mode 100644 index 1b2ada99a1..0000000000 --- a/docs/zh-CN/1.1.3/site-preparation.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.3

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/site-preparation/index.html b/docs/zh-CN/1.1.3/site-preparation/index.html deleted file mode 100644 index 1b2ada99a1..0000000000 --- a/docs/zh-CN/1.1.3/site-preparation/index.html +++ /dev/null @@ -1,103 +0,0 @@ -Site Preparation · Docusaurus

1.1.3

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-of-repo
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-├── website
-│   ├── blog-examples-from-docusaurus
-│   │   ├── 2016-03-11-blog-post.md
-│   │   └── 2017-04-10-blog-post-two.md
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/translation.html b/docs/zh-CN/1.1.3/translation.html deleted file mode 100644 index 038e4400d9..0000000000 --- a/docs/zh-CN/1.1.3/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.3

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/translation/index.html b/docs/zh-CN/1.1.3/translation/index.html deleted file mode 100644 index 038e4400d9..0000000000 --- a/docs/zh-CN/1.1.3/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.3

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/versioning.html b/docs/zh-CN/1.1.3/versioning.html deleted file mode 100644 index 9a83c460a9..0000000000 --- a/docs/zh-CN/1.1.3/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.3

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.3/versioning/index.html b/docs/zh-CN/1.1.3/versioning/index.html deleted file mode 100644 index 9a83c460a9..0000000000 --- a/docs/zh-CN/1.1.3/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.3

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/api-pages.html b/docs/zh-CN/1.1.4/api-pages.html deleted file mode 100644 index 1a054cc5a4..0000000000 --- a/docs/zh-CN/1.1.4/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.4

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/api-pages/index.html b/docs/zh-CN/1.1.4/api-pages/index.html deleted file mode 100644 index 1a054cc5a4..0000000000 --- a/docs/zh-CN/1.1.4/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.4

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/blog.html b/docs/zh-CN/1.1.4/blog.html deleted file mode 100644 index 2e55dbe000..0000000000 --- a/docs/zh-CN/1.1.4/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.4

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/blog/index.html b/docs/zh-CN/1.1.4/blog/index.html deleted file mode 100644 index 2e55dbe000..0000000000 --- a/docs/zh-CN/1.1.4/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.4

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/commands.html b/docs/zh-CN/1.1.4/commands.html deleted file mode 100644 index a9a6196f32..0000000000 --- a/docs/zh-CN/1.1.4/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.4

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/commands/index.html b/docs/zh-CN/1.1.4/commands/index.html deleted file mode 100644 index a9a6196f32..0000000000 --- a/docs/zh-CN/1.1.4/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.4

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/custom-pages.html b/docs/zh-CN/1.1.4/custom-pages.html deleted file mode 100644 index bce0420d23..0000000000 --- a/docs/zh-CN/1.1.4/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.4

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/custom-pages/index.html b/docs/zh-CN/1.1.4/custom-pages/index.html deleted file mode 100644 index bce0420d23..0000000000 --- a/docs/zh-CN/1.1.4/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.4

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/doc-markdown.html b/docs/zh-CN/1.1.4/doc-markdown.html deleted file mode 100644 index b6b2cd4f2d..0000000000 --- a/docs/zh-CN/1.1.4/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.4

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/doc-markdown/index.html b/docs/zh-CN/1.1.4/doc-markdown/index.html deleted file mode 100644 index b6b2cd4f2d..0000000000 --- a/docs/zh-CN/1.1.4/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.4

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/installation.html b/docs/zh-CN/1.1.4/installation.html deleted file mode 100644 index ee5ab24be8..0000000000 --- a/docs/zh-CN/1.1.4/installation.html +++ /dev/null @@ -1,118 +0,0 @@ -Installation · Docusaurus

1.1.4

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/installation/index.html b/docs/zh-CN/1.1.4/installation/index.html deleted file mode 100644 index ee5ab24be8..0000000000 --- a/docs/zh-CN/1.1.4/installation/index.html +++ /dev/null @@ -1,118 +0,0 @@ -Installation · Docusaurus

1.1.4

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/navigation.html b/docs/zh-CN/1.1.4/navigation.html deleted file mode 100644 index 30edc16f66..0000000000 --- a/docs/zh-CN/1.1.4/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.4

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/navigation/index.html b/docs/zh-CN/1.1.4/navigation/index.html deleted file mode 100644 index 30edc16f66..0000000000 --- a/docs/zh-CN/1.1.4/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.4

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/publishing.html b/docs/zh-CN/1.1.4/publishing.html deleted file mode 100644 index 11436cb7ce..0000000000 --- a/docs/zh-CN/1.1.4/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.4

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/publishing/index.html b/docs/zh-CN/1.1.4/publishing/index.html deleted file mode 100644 index 11436cb7ce..0000000000 --- a/docs/zh-CN/1.1.4/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.4

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/search.html b/docs/zh-CN/1.1.4/search.html deleted file mode 100644 index d271458e66..0000000000 --- a/docs/zh-CN/1.1.4/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.4

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/search/index.html b/docs/zh-CN/1.1.4/search/index.html deleted file mode 100644 index d271458e66..0000000000 --- a/docs/zh-CN/1.1.4/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.4

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/site-config.html b/docs/zh-CN/1.1.4/site-config.html deleted file mode 100644 index deedfc45bc..0000000000 --- a/docs/zh-CN/1.1.4/site-config.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.4

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/site-config/index.html b/docs/zh-CN/1.1.4/site-config/index.html deleted file mode 100644 index deedfc45bc..0000000000 --- a/docs/zh-CN/1.1.4/site-config/index.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.4

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/site-creation.html b/docs/zh-CN/1.1.4/site-creation.html deleted file mode 100644 index 4c559abe77..0000000000 --- a/docs/zh-CN/1.1.4/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.4

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/site-creation/index.html b/docs/zh-CN/1.1.4/site-creation/index.html deleted file mode 100644 index 4c559abe77..0000000000 --- a/docs/zh-CN/1.1.4/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.4

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/site-preparation.html b/docs/zh-CN/1.1.4/site-preparation.html deleted file mode 100644 index 734bd0a537..0000000000 --- a/docs/zh-CN/1.1.4/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.1.4

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/site-preparation/index.html b/docs/zh-CN/1.1.4/site-preparation/index.html deleted file mode 100644 index 734bd0a537..0000000000 --- a/docs/zh-CN/1.1.4/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.1.4

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/translation.html b/docs/zh-CN/1.1.4/translation.html deleted file mode 100644 index 4d2f005cbe..0000000000 --- a/docs/zh-CN/1.1.4/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.4

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/translation/index.html b/docs/zh-CN/1.1.4/translation/index.html deleted file mode 100644 index 4d2f005cbe..0000000000 --- a/docs/zh-CN/1.1.4/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.4

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/versioning.html b/docs/zh-CN/1.1.4/versioning.html deleted file mode 100644 index d38e6429a0..0000000000 --- a/docs/zh-CN/1.1.4/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.4

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.4/versioning/index.html b/docs/zh-CN/1.1.4/versioning/index.html deleted file mode 100644 index d38e6429a0..0000000000 --- a/docs/zh-CN/1.1.4/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.4

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/api-pages.html b/docs/zh-CN/1.1.5/api-pages.html deleted file mode 100644 index 998bec4125..0000000000 --- a/docs/zh-CN/1.1.5/api-pages.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.5

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/api-pages/index.html b/docs/zh-CN/1.1.5/api-pages/index.html deleted file mode 100644 index 998bec4125..0000000000 --- a/docs/zh-CN/1.1.5/api-pages/index.html +++ /dev/null @@ -1,185 +0,0 @@ -Pages and Styles · Docusaurus

1.1.5

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

-

URLs for Pages

-

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js file. E.g. The url for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static folder. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/blog.html b/docs/zh-CN/1.1.5/blog.html deleted file mode 100644 index a14990797d..0000000000 --- a/docs/zh-CN/1.1.5/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.5

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/blog/index.html b/docs/zh-CN/1.1.5/blog/index.html deleted file mode 100644 index a14990797d..0000000000 --- a/docs/zh-CN/1.1.5/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.1.5

Translate

Adding a Blog

初始设置

-

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

-

例如：

-
blogSidebarCount: 'ALL'
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/commands.html b/docs/zh-CN/1.1.5/commands.html deleted file mode 100644 index e78dd7e0dd..0000000000 --- a/docs/zh-CN/1.1.5/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.5

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/commands/index.html b/docs/zh-CN/1.1.5/commands/index.html deleted file mode 100644 index e78dd7e0dd..0000000000 --- a/docs/zh-CN/1.1.5/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.1.5

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -

  • GIT_USER: 与部署提交联系的 GIT 用户。

    • -

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    -

    Example

    -
    GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
    • -
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/custom-pages.html b/docs/zh-CN/1.1.5/custom-pages.html deleted file mode 100644 index a134f28008..0000000000 --- a/docs/zh-CN/1.1.5/custom-pages.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.5

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/custom-pages/index.html b/docs/zh-CN/1.1.5/custom-pages/index.html deleted file mode 100644 index a134f28008..0000000000 --- a/docs/zh-CN/1.1.5/custom-pages/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Custom Pages · Docusaurus

1.1.5

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   │   ├── index.js
-│   │   ├── users.js
-│   │   └── help.js
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/doc-markdown.html b/docs/zh-CN/1.1.5/doc-markdown.html deleted file mode 100644 index 30fe8f49be..0000000000 --- a/docs/zh-CN/1.1.5/doc-markdown.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.5

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/doc-markdown/index.html b/docs/zh-CN/1.1.5/doc-markdown/index.html deleted file mode 100644 index 30fe8f49be..0000000000 --- a/docs/zh-CN/1.1.5/doc-markdown/index.html +++ /dev/null @@ -1,182 +0,0 @@ -Markdown Features · Docusaurus

1.1.5

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

-

链接到图像和其它资源

-

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
-  <h1>Hello, world!</h1>,
-  document.getElementById('root')
-);
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/installation.html b/docs/zh-CN/1.1.5/installation.html deleted file mode 100644 index e9b8f8695b..0000000000 --- a/docs/zh-CN/1.1.5/installation.html +++ /dev/null @@ -1,118 +0,0 @@ -Installation · Docusaurus

1.1.5

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/installation/index.html b/docs/zh-CN/1.1.5/installation/index.html deleted file mode 100644 index e9b8f8695b..0000000000 --- a/docs/zh-CN/1.1.5/installation/index.html +++ /dev/null @@ -1,118 +0,0 @@ -Installation · Docusaurus

1.1.5

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/navigation.html b/docs/zh-CN/1.1.5/navigation.html deleted file mode 100644 index 579f938e65..0000000000 --- a/docs/zh-CN/1.1.5/navigation.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.5

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/navigation/index.html b/docs/zh-CN/1.1.5/navigation/index.html deleted file mode 100644 index 579f938e65..0000000000 --- a/docs/zh-CN/1.1.5/navigation/index.html +++ /dev/null @@ -1,218 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.1.5

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-
-

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/publishing.html b/docs/zh-CN/1.1.5/publishing.html deleted file mode 100644 index 1ef2218ab5..0000000000 --- a/docs/zh-CN/1.1.5/publishing.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.5

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/publishing/index.html b/docs/zh-CN/1.1.5/publishing/index.html deleted file mode 100644 index 1ef2218ab5..0000000000 --- a/docs/zh-CN/1.1.5/publishing/index.html +++ /dev/null @@ -1,224 +0,0 @@ -Publishing your site · Docusaurus

1.1.5

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

-
-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repo is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci folder and create a config.yml under that folder.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      -run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/search.html b/docs/zh-CN/1.1.5/search.html deleted file mode 100644 index 91a69e604d..0000000000 --- a/docs/zh-CN/1.1.5/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.5

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/search/index.html b/docs/zh-CN/1.1.5/search/index.html deleted file mode 100644 index 91a69e604d..0000000000 --- a/docs/zh-CN/1.1.5/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.1.5

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/site-config.html b/docs/zh-CN/1.1.5/site-config.html deleted file mode 100644 index d27b9e25fc..0000000000 --- a/docs/zh-CN/1.1.5/site-config.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.5

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/site-config/index.html b/docs/zh-CN/1.1.5/site-config/index.html deleted file mode 100644 index d27b9e25fc..0000000000 --- a/docs/zh-CN/1.1.5/site-config/index.html +++ /dev/null @@ -1,251 +0,0 @@ -siteConfig.js · Docusaurus

1.1.5

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - 网站图标的url。

-

headerIcon - 标题导航栏中使用的图标的 url。

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - url for your site.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the url and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/site-creation.html b/docs/zh-CN/1.1.5/site-creation.html deleted file mode 100644 index d1540c5c34..0000000000 --- a/docs/zh-CN/1.1.5/site-creation.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.5

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/site-creation/index.html b/docs/zh-CN/1.1.5/site-creation/index.html deleted file mode 100644 index d1540c5c34..0000000000 --- a/docs/zh-CN/1.1.5/site-creation/index.html +++ /dev/null @@ -1,142 +0,0 @@ -Creating your site · Docusaurus

1.1.5

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-of-repo
-├── docs
-├── website
-│   ├── blog
-│   ├── core
-│   │   └── Footer.js
-│   ├── node_modules
-│   ├── package.json
-│   ├── pages
-│   ├── sidebars.json
-│   ├── siteConfig.js
-│   └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    -
    -

    If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

    -
    3. -

  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.

    4. -

  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.

    5. -

  5. Place assets, such as images, in the website/static/ folder.

    6. -

  6. Run the site to see the results of your changes.

    -
    cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
    7. -
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/site-preparation.html b/docs/zh-CN/1.1.5/site-preparation.html deleted file mode 100644 index 7e5d781257..0000000000 --- a/docs/zh-CN/1.1.5/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.1.5

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/site-preparation/index.html b/docs/zh-CN/1.1.5/site-preparation/index.html deleted file mode 100644 index 7e5d781257..0000000000 --- a/docs/zh-CN/1.1.5/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.1.5

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • -
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • -
  • website/pages文件夹中包含示例网站的顶层页面。
    • -
  • website/static 文件夹包含示例网站使用的静态资源。
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/translation.html b/docs/zh-CN/1.1.5/translation.html deleted file mode 100644 index 0cf50bd513..0000000000 --- a/docs/zh-CN/1.1.5/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.5

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/translation/index.html b/docs/zh-CN/1.1.5/translation/index.html deleted file mode 100644 index 0cf50bd513..0000000000 --- a/docs/zh-CN/1.1.5/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.1.5

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

需要翻译文本的网页应放在 website/pages/en 文件夹中。

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/versioning.html b/docs/zh-CN/1.1.5/versioning.html deleted file mode 100644 index f753ba3c60..0000000000 --- a/docs/zh-CN/1.1.5/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.5

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.5/versioning/index.html b/docs/zh-CN/1.1.5/versioning/index.html deleted file mode 100644 index f753ba3c60..0000000000 --- a/docs/zh-CN/1.1.5/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.1.5

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs folder and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs folder. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/api-pages.html b/docs/zh-CN/1.2.0/api-pages.html deleted file mode 100644 index b6babaf706..0000000000 --- a/docs/zh-CN/1.2.0/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.2.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/api-pages/index.html b/docs/zh-CN/1.2.0/api-pages/index.html deleted file mode 100644 index b6babaf706..0000000000 --- a/docs/zh-CN/1.2.0/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.2.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/blog.html b/docs/zh-CN/1.2.0/blog.html deleted file mode 100644 index fbef86e2d5..0000000000 --- a/docs/zh-CN/1.2.0/blog.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.2.0

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/blog/index.html b/docs/zh-CN/1.2.0/blog/index.html deleted file mode 100644 index fbef86e2d5..0000000000 --- a/docs/zh-CN/1.2.0/blog/index.html +++ /dev/null @@ -1,186 +0,0 @@ -Adding a Blog · Docusaurus

1.2.0

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/commands.html b/docs/zh-CN/1.2.0/commands.html deleted file mode 100644 index ceff86e208..0000000000 --- a/docs/zh-CN/1.2.0/commands.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.2.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/commands/index.html b/docs/zh-CN/1.2.0/commands/index.html deleted file mode 100644 index ceff86e208..0000000000 --- a/docs/zh-CN/1.2.0/commands/index.html +++ /dev/null @@ -1,182 +0,0 @@ -CLI Commands · Docusaurus

1.2.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/custom-pages.html b/docs/zh-CN/1.2.0/custom-pages.html deleted file mode 100644 index 2f140cbfd6..0000000000 --- a/docs/zh-CN/1.2.0/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.2.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/custom-pages/index.html b/docs/zh-CN/1.2.0/custom-pages/index.html deleted file mode 100644 index 2f140cbfd6..0000000000 --- a/docs/zh-CN/1.2.0/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.2.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/doc-markdown.html b/docs/zh-CN/1.2.0/doc-markdown.html deleted file mode 100644 index 0c9a141c80..0000000000 --- a/docs/zh-CN/1.2.0/doc-markdown.html +++ /dev/null @@ -1,197 +0,0 @@ -Markdown Features · Docusaurus

1.2.0

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
* `docusaurus.function(a, b)`
-* `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/doc-markdown/index.html b/docs/zh-CN/1.2.0/doc-markdown/index.html deleted file mode 100644 index 0c9a141c80..0000000000 --- a/docs/zh-CN/1.2.0/doc-markdown/index.html +++ /dev/null @@ -1,197 +0,0 @@ -Markdown Features · Docusaurus

1.2.0

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
* `docusaurus.function(a, b)`
-* `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/installation.html b/docs/zh-CN/1.2.0/installation.html deleted file mode 100644 index 81abffee15..0000000000 --- a/docs/zh-CN/1.2.0/installation.html +++ /dev/null @@ -1,118 +0,0 @@ -Installation · Docusaurus

1.2.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/installation/index.html b/docs/zh-CN/1.2.0/installation/index.html deleted file mode 100644 index 81abffee15..0000000000 --- a/docs/zh-CN/1.2.0/installation/index.html +++ /dev/null @@ -1,118 +0,0 @@ -Installation · Docusaurus

1.2.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/navigation.html b/docs/zh-CN/1.2.0/navigation.html deleted file mode 100644 index 42922cc537..0000000000 --- a/docs/zh-CN/1.2.0/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.2.0

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/navigation/index.html b/docs/zh-CN/1.2.0/navigation/index.html deleted file mode 100644 index 42922cc537..0000000000 --- a/docs/zh-CN/1.2.0/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.2.0

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/publishing.html b/docs/zh-CN/1.2.0/publishing.html deleted file mode 100644 index 479f39d857..0000000000 --- a/docs/zh-CN/1.2.0/publishing.html +++ /dev/null @@ -1,259 +0,0 @@ -Publishing your site · Docusaurus

1.2.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/publishing/index.html b/docs/zh-CN/1.2.0/publishing/index.html deleted file mode 100644 index 479f39d857..0000000000 --- a/docs/zh-CN/1.2.0/publishing/index.html +++ /dev/null @@ -1,259 +0,0 @@ -Publishing your site · Docusaurus

1.2.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/search.html b/docs/zh-CN/1.2.0/search.html deleted file mode 100644 index a9d7d39994..0000000000 --- a/docs/zh-CN/1.2.0/search.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.2.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/search/index.html b/docs/zh-CN/1.2.0/search/index.html deleted file mode 100644 index a9d7d39994..0000000000 --- a/docs/zh-CN/1.2.0/search/index.html +++ /dev/null @@ -1,100 +0,0 @@ -Enabling Search · Docusaurus

1.2.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/site-config.html b/docs/zh-CN/1.2.0/site-config.html deleted file mode 100644 index a2e19f8b97..0000000000 --- a/docs/zh-CN/1.2.0/site-config.html +++ /dev/null @@ -1,261 +0,0 @@ -siteConfig.js · Docusaurus

1.2.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/site-config/index.html b/docs/zh-CN/1.2.0/site-config/index.html deleted file mode 100644 index a2e19f8b97..0000000000 --- a/docs/zh-CN/1.2.0/site-config/index.html +++ /dev/null @@ -1,261 +0,0 @@ -siteConfig.js · Docusaurus

1.2.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/site-creation.html b/docs/zh-CN/1.2.0/site-creation.html deleted file mode 100644 index a58b6c3667..0000000000 --- a/docs/zh-CN/1.2.0/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.2.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/site-creation/index.html b/docs/zh-CN/1.2.0/site-creation/index.html deleted file mode 100644 index a58b6c3667..0000000000 --- a/docs/zh-CN/1.2.0/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.2.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/site-preparation.html b/docs/zh-CN/1.2.0/site-preparation.html deleted file mode 100644 index 6c22fb85fe..0000000000 --- a/docs/zh-CN/1.2.0/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.2.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/site-preparation/index.html b/docs/zh-CN/1.2.0/site-preparation/index.html deleted file mode 100644 index 6c22fb85fe..0000000000 --- a/docs/zh-CN/1.2.0/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.2.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/translation.html b/docs/zh-CN/1.2.0/translation.html deleted file mode 100644 index c1538972c0..0000000000 --- a/docs/zh-CN/1.2.0/translation.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.2.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/translation/index.html b/docs/zh-CN/1.2.0/translation/index.html deleted file mode 100644 index c1538972c0..0000000000 --- a/docs/zh-CN/1.2.0/translation/index.html +++ /dev/null @@ -1,243 +0,0 @@ -Translations & Localization · Docusaurus

1.2.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/versioning.html b/docs/zh-CN/1.2.0/versioning.html deleted file mode 100644 index a91e0ab6d8..0000000000 --- a/docs/zh-CN/1.2.0/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.2.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.0/versioning/index.html b/docs/zh-CN/1.2.0/versioning/index.html deleted file mode 100644 index a91e0ab6d8..0000000000 --- a/docs/zh-CN/1.2.0/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.2.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/api-pages.html b/docs/zh-CN/1.2.1/api-pages.html deleted file mode 100644 index 230e7b257f..0000000000 --- a/docs/zh-CN/1.2.1/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.2.1

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/api-pages/index.html b/docs/zh-CN/1.2.1/api-pages/index.html deleted file mode 100644 index 230e7b257f..0000000000 --- a/docs/zh-CN/1.2.1/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.2.1

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/blog.html b/docs/zh-CN/1.2.1/blog.html deleted file mode 100644 index f773ca64f6..0000000000 --- a/docs/zh-CN/1.2.1/blog.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.2.1

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/blog/index.html b/docs/zh-CN/1.2.1/blog/index.html deleted file mode 100644 index f773ca64f6..0000000000 --- a/docs/zh-CN/1.2.1/blog/index.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.2.1

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/commands.html b/docs/zh-CN/1.2.1/commands.html deleted file mode 100644 index 9f754d0f17..0000000000 --- a/docs/zh-CN/1.2.1/commands.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.2.1

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/commands/index.html b/docs/zh-CN/1.2.1/commands/index.html deleted file mode 100644 index 9f754d0f17..0000000000 --- a/docs/zh-CN/1.2.1/commands/index.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.2.1

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/custom-pages.html b/docs/zh-CN/1.2.1/custom-pages.html deleted file mode 100644 index f55ae29776..0000000000 --- a/docs/zh-CN/1.2.1/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.2.1

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/custom-pages/index.html b/docs/zh-CN/1.2.1/custom-pages/index.html deleted file mode 100644 index f55ae29776..0000000000 --- a/docs/zh-CN/1.2.1/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.2.1

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/doc-markdown.html b/docs/zh-CN/1.2.1/doc-markdown.html deleted file mode 100644 index 3c419633bb..0000000000 --- a/docs/zh-CN/1.2.1/doc-markdown.html +++ /dev/null @@ -1,197 +0,0 @@ -Markdown Features · Docusaurus

1.2.1

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
* `docusaurus.function(a, b)`
-* `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/doc-markdown/index.html b/docs/zh-CN/1.2.1/doc-markdown/index.html deleted file mode 100644 index 3c419633bb..0000000000 --- a/docs/zh-CN/1.2.1/doc-markdown/index.html +++ /dev/null @@ -1,197 +0,0 @@ -Markdown Features · Docusaurus

1.2.1

Translate

Markdown Features

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
* `docusaurus.function(a, b)`
-* `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/installation.html b/docs/zh-CN/1.2.1/installation.html deleted file mode 100644 index b87d67a0a9..0000000000 --- a/docs/zh-CN/1.2.1/installation.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.2.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/installation/index.html b/docs/zh-CN/1.2.1/installation/index.html deleted file mode 100644 index b87d67a0a9..0000000000 --- a/docs/zh-CN/1.2.1/installation/index.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.2.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/navigation.html b/docs/zh-CN/1.2.1/navigation.html deleted file mode 100644 index f10d7cc33d..0000000000 --- a/docs/zh-CN/1.2.1/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.2.1

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/navigation/index.html b/docs/zh-CN/1.2.1/navigation/index.html deleted file mode 100644 index f10d7cc33d..0000000000 --- a/docs/zh-CN/1.2.1/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.2.1

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/publishing.html b/docs/zh-CN/1.2.1/publishing.html deleted file mode 100644 index 5116dff347..0000000000 --- a/docs/zh-CN/1.2.1/publishing.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.2.1

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/publishing/index.html b/docs/zh-CN/1.2.1/publishing/index.html deleted file mode 100644 index 5116dff347..0000000000 --- a/docs/zh-CN/1.2.1/publishing/index.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.2.1

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/search.html b/docs/zh-CN/1.2.1/search.html deleted file mode 100644 index 82a143e35d..0000000000 --- a/docs/zh-CN/1.2.1/search.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.2.1

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/search/index.html b/docs/zh-CN/1.2.1/search/index.html deleted file mode 100644 index 82a143e35d..0000000000 --- a/docs/zh-CN/1.2.1/search/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.2.1

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/site-config.html b/docs/zh-CN/1.2.1/site-config.html deleted file mode 100644 index 34ce09acef..0000000000 --- a/docs/zh-CN/1.2.1/site-config.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.2.1

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/site-config/index.html b/docs/zh-CN/1.2.1/site-config/index.html deleted file mode 100644 index 34ce09acef..0000000000 --- a/docs/zh-CN/1.2.1/site-config/index.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.2.1

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/site-creation.html b/docs/zh-CN/1.2.1/site-creation.html deleted file mode 100644 index 06dfed04eb..0000000000 --- a/docs/zh-CN/1.2.1/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.2.1

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/site-creation/index.html b/docs/zh-CN/1.2.1/site-creation/index.html deleted file mode 100644 index 06dfed04eb..0000000000 --- a/docs/zh-CN/1.2.1/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.2.1

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/site-preparation.html b/docs/zh-CN/1.2.1/site-preparation.html deleted file mode 100644 index bc38036b72..0000000000 --- a/docs/zh-CN/1.2.1/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.2.1

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/site-preparation/index.html b/docs/zh-CN/1.2.1/site-preparation/index.html deleted file mode 100644 index bc38036b72..0000000000 --- a/docs/zh-CN/1.2.1/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.2.1

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/translation.html b/docs/zh-CN/1.2.1/translation.html deleted file mode 100644 index 4129203ab6..0000000000 --- a/docs/zh-CN/1.2.1/translation.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.2.1

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/translation/index.html b/docs/zh-CN/1.2.1/translation/index.html deleted file mode 100644 index 4129203ab6..0000000000 --- a/docs/zh-CN/1.2.1/translation/index.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.2.1

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/versioning.html b/docs/zh-CN/1.2.1/versioning.html deleted file mode 100644 index bf2943e076..0000000000 --- a/docs/zh-CN/1.2.1/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.2.1

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.1/versioning/index.html b/docs/zh-CN/1.2.1/versioning/index.html deleted file mode 100644 index bf2943e076..0000000000 --- a/docs/zh-CN/1.2.1/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.2.1

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/adding-blog.html b/docs/zh-CN/1.3.0/adding-blog.html deleted file mode 100644 index 7e4e7e00cc..0000000000 --- a/docs/zh-CN/1.3.0/adding-blog.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.0

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/adding-blog/index.html b/docs/zh-CN/1.3.0/adding-blog/index.html deleted file mode 100644 index 7e4e7e00cc..0000000000 --- a/docs/zh-CN/1.3.0/adding-blog/index.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.0

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/api-pages.html b/docs/zh-CN/1.3.0/api-pages.html deleted file mode 100644 index 119fdab3f3..0000000000 --- a/docs/zh-CN/1.3.0/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/api-pages/index.html b/docs/zh-CN/1.3.0/api-pages/index.html deleted file mode 100644 index 119fdab3f3..0000000000 --- a/docs/zh-CN/1.3.0/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/blog.html b/docs/zh-CN/1.3.0/blog.html deleted file mode 100644 index 04188aaec1..0000000000 --- a/docs/zh-CN/1.3.0/blog.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.0

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/blog/index.html b/docs/zh-CN/1.3.0/blog/index.html deleted file mode 100644 index 04188aaec1..0000000000 --- a/docs/zh-CN/1.3.0/blog/index.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.0

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/commands.html b/docs/zh-CN/1.3.0/commands.html deleted file mode 100644 index 355b7a7c2b..0000000000 --- a/docs/zh-CN/1.3.0/commands.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/commands/index.html b/docs/zh-CN/1.3.0/commands/index.html deleted file mode 100644 index 355b7a7c2b..0000000000 --- a/docs/zh-CN/1.3.0/commands/index.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/custom-pages.html b/docs/zh-CN/1.3.0/custom-pages.html deleted file mode 100644 index 80d9944d84..0000000000 --- a/docs/zh-CN/1.3.0/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/custom-pages/index.html b/docs/zh-CN/1.3.0/custom-pages/index.html deleted file mode 100644 index 80d9944d84..0000000000 --- a/docs/zh-CN/1.3.0/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/doc-markdown.html b/docs/zh-CN/1.3.0/doc-markdown.html deleted file mode 100644 index fac570e001..0000000000 --- a/docs/zh-CN/1.3.0/doc-markdown.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.0

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/doc-markdown/index.html b/docs/zh-CN/1.3.0/doc-markdown/index.html deleted file mode 100644 index fac570e001..0000000000 --- a/docs/zh-CN/1.3.0/doc-markdown/index.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.0

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/installation.html b/docs/zh-CN/1.3.0/installation.html deleted file mode 100644 index 5e2241fd9b..0000000000 --- a/docs/zh-CN/1.3.0/installation.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.3.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/installation/index.html b/docs/zh-CN/1.3.0/installation/index.html deleted file mode 100644 index 5e2241fd9b..0000000000 --- a/docs/zh-CN/1.3.0/installation/index.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.3.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/navigation.html b/docs/zh-CN/1.3.0/navigation.html deleted file mode 100644 index 41048ce67c..0000000000 --- a/docs/zh-CN/1.3.0/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.0

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/navigation/index.html b/docs/zh-CN/1.3.0/navigation/index.html deleted file mode 100644 index 41048ce67c..0000000000 --- a/docs/zh-CN/1.3.0/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.0

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/publishing.html b/docs/zh-CN/1.3.0/publishing.html deleted file mode 100644 index b1632b6482..0000000000 --- a/docs/zh-CN/1.3.0/publishing.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/publishing/index.html b/docs/zh-CN/1.3.0/publishing/index.html deleted file mode 100644 index b1632b6482..0000000000 --- a/docs/zh-CN/1.3.0/publishing/index.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/search.html b/docs/zh-CN/1.3.0/search.html deleted file mode 100644 index 85ff5ef4b9..0000000000 --- a/docs/zh-CN/1.3.0/search.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/search/index.html b/docs/zh-CN/1.3.0/search/index.html deleted file mode 100644 index 85ff5ef4b9..0000000000 --- a/docs/zh-CN/1.3.0/search/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/site-config.html b/docs/zh-CN/1.3.0/site-config.html deleted file mode 100644 index 9d7de8eccc..0000000000 --- a/docs/zh-CN/1.3.0/site-config.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/site-config/index.html b/docs/zh-CN/1.3.0/site-config/index.html deleted file mode 100644 index 9d7de8eccc..0000000000 --- a/docs/zh-CN/1.3.0/site-config/index.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/site-creation.html b/docs/zh-CN/1.3.0/site-creation.html deleted file mode 100644 index 468e353d2b..0000000000 --- a/docs/zh-CN/1.3.0/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/site-creation/index.html b/docs/zh-CN/1.3.0/site-creation/index.html deleted file mode 100644 index 468e353d2b..0000000000 --- a/docs/zh-CN/1.3.0/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/site-preparation.html b/docs/zh-CN/1.3.0/site-preparation.html deleted file mode 100644 index f0ecff8e26..0000000000 --- a/docs/zh-CN/1.3.0/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.3.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/site-preparation/index.html b/docs/zh-CN/1.3.0/site-preparation/index.html deleted file mode 100644 index f0ecff8e26..0000000000 --- a/docs/zh-CN/1.3.0/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.3.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/translation.html b/docs/zh-CN/1.3.0/translation.html deleted file mode 100644 index 6fd27bf969..0000000000 --- a/docs/zh-CN/1.3.0/translation.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.3.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/translation/index.html b/docs/zh-CN/1.3.0/translation/index.html deleted file mode 100644 index 6fd27bf969..0000000000 --- a/docs/zh-CN/1.3.0/translation/index.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.3.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/versioning.html b/docs/zh-CN/1.3.0/versioning.html deleted file mode 100644 index 3c86dc6ccd..0000000000 --- a/docs/zh-CN/1.3.0/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.0/versioning/index.html b/docs/zh-CN/1.3.0/versioning/index.html deleted file mode 100644 index 3c86dc6ccd..0000000000 --- a/docs/zh-CN/1.3.0/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/adding-blog.html b/docs/zh-CN/1.3.1/adding-blog.html deleted file mode 100644 index 5fc9f84a77..0000000000 --- a/docs/zh-CN/1.3.1/adding-blog.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.1

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/adding-blog/index.html b/docs/zh-CN/1.3.1/adding-blog/index.html deleted file mode 100644 index 5fc9f84a77..0000000000 --- a/docs/zh-CN/1.3.1/adding-blog/index.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.1

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/api-pages.html b/docs/zh-CN/1.3.1/api-pages.html deleted file mode 100644 index e5c8d855e8..0000000000 --- a/docs/zh-CN/1.3.1/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.1

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/api-pages/index.html b/docs/zh-CN/1.3.1/api-pages/index.html deleted file mode 100644 index e5c8d855e8..0000000000 --- a/docs/zh-CN/1.3.1/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.1

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/blog.html b/docs/zh-CN/1.3.1/blog.html deleted file mode 100644 index 92930c1edc..0000000000 --- a/docs/zh-CN/1.3.1/blog.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.1

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/blog/index.html b/docs/zh-CN/1.3.1/blog/index.html deleted file mode 100644 index 92930c1edc..0000000000 --- a/docs/zh-CN/1.3.1/blog/index.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.1

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/commands.html b/docs/zh-CN/1.3.1/commands.html deleted file mode 100644 index 1773754faa..0000000000 --- a/docs/zh-CN/1.3.1/commands.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.1

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/commands/index.html b/docs/zh-CN/1.3.1/commands/index.html deleted file mode 100644 index 1773754faa..0000000000 --- a/docs/zh-CN/1.3.1/commands/index.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.1

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/custom-pages.html b/docs/zh-CN/1.3.1/custom-pages.html deleted file mode 100644 index 121333cab3..0000000000 --- a/docs/zh-CN/1.3.1/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.1

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/custom-pages/index.html b/docs/zh-CN/1.3.1/custom-pages/index.html deleted file mode 100644 index 121333cab3..0000000000 --- a/docs/zh-CN/1.3.1/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.1

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/doc-markdown.html b/docs/zh-CN/1.3.1/doc-markdown.html deleted file mode 100644 index eb0828f57e..0000000000 --- a/docs/zh-CN/1.3.1/doc-markdown.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.1

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/doc-markdown/index.html b/docs/zh-CN/1.3.1/doc-markdown/index.html deleted file mode 100644 index eb0828f57e..0000000000 --- a/docs/zh-CN/1.3.1/doc-markdown/index.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.1

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/installation.html b/docs/zh-CN/1.3.1/installation.html deleted file mode 100644 index 5511a1d79d..0000000000 --- a/docs/zh-CN/1.3.1/installation.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.3.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/installation/index.html b/docs/zh-CN/1.3.1/installation/index.html deleted file mode 100644 index 5511a1d79d..0000000000 --- a/docs/zh-CN/1.3.1/installation/index.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.3.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/navigation.html b/docs/zh-CN/1.3.1/navigation.html deleted file mode 100644 index c6eefff41c..0000000000 --- a/docs/zh-CN/1.3.1/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.1

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/navigation/index.html b/docs/zh-CN/1.3.1/navigation/index.html deleted file mode 100644 index c6eefff41c..0000000000 --- a/docs/zh-CN/1.3.1/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.1

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/publishing.html b/docs/zh-CN/1.3.1/publishing.html deleted file mode 100644 index 0d9bbaacce..0000000000 --- a/docs/zh-CN/1.3.1/publishing.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.1

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/publishing/index.html b/docs/zh-CN/1.3.1/publishing/index.html deleted file mode 100644 index 0d9bbaacce..0000000000 --- a/docs/zh-CN/1.3.1/publishing/index.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.1

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/search.html b/docs/zh-CN/1.3.1/search.html deleted file mode 100644 index 19dbd6c228..0000000000 --- a/docs/zh-CN/1.3.1/search.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.1

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/search/index.html b/docs/zh-CN/1.3.1/search/index.html deleted file mode 100644 index 19dbd6c228..0000000000 --- a/docs/zh-CN/1.3.1/search/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.1

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/site-config.html b/docs/zh-CN/1.3.1/site-config.html deleted file mode 100644 index 27867f1d5c..0000000000 --- a/docs/zh-CN/1.3.1/site-config.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.1

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/site-config/index.html b/docs/zh-CN/1.3.1/site-config/index.html deleted file mode 100644 index 27867f1d5c..0000000000 --- a/docs/zh-CN/1.3.1/site-config/index.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.1

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/site-creation.html b/docs/zh-CN/1.3.1/site-creation.html deleted file mode 100644 index 8f83997737..0000000000 --- a/docs/zh-CN/1.3.1/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.1

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/site-creation/index.html b/docs/zh-CN/1.3.1/site-creation/index.html deleted file mode 100644 index 8f83997737..0000000000 --- a/docs/zh-CN/1.3.1/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.1

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/site-preparation.html b/docs/zh-CN/1.3.1/site-preparation.html deleted file mode 100644 index ca1aada988..0000000000 --- a/docs/zh-CN/1.3.1/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.3.1

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/site-preparation/index.html b/docs/zh-CN/1.3.1/site-preparation/index.html deleted file mode 100644 index ca1aada988..0000000000 --- a/docs/zh-CN/1.3.1/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.3.1

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/translation.html b/docs/zh-CN/1.3.1/translation.html deleted file mode 100644 index 4b0cebb3b8..0000000000 --- a/docs/zh-CN/1.3.1/translation.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.3.1

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/translation/index.html b/docs/zh-CN/1.3.1/translation/index.html deleted file mode 100644 index 4b0cebb3b8..0000000000 --- a/docs/zh-CN/1.3.1/translation/index.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.3.1

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/versioning.html b/docs/zh-CN/1.3.1/versioning.html deleted file mode 100644 index b259b9d086..0000000000 --- a/docs/zh-CN/1.3.1/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.1

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.1/versioning/index.html b/docs/zh-CN/1.3.1/versioning/index.html deleted file mode 100644 index b259b9d086..0000000000 --- a/docs/zh-CN/1.3.1/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.1

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/adding-blog.html b/docs/zh-CN/1.3.2/adding-blog.html deleted file mode 100644 index 1c7dbe9d99..0000000000 --- a/docs/zh-CN/1.3.2/adding-blog.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.2

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/adding-blog/index.html b/docs/zh-CN/1.3.2/adding-blog/index.html deleted file mode 100644 index 1c7dbe9d99..0000000000 --- a/docs/zh-CN/1.3.2/adding-blog/index.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.2

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/api-pages.html b/docs/zh-CN/1.3.2/api-pages.html deleted file mode 100644 index a18d619f28..0000000000 --- a/docs/zh-CN/1.3.2/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.2

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/api-pages/index.html b/docs/zh-CN/1.3.2/api-pages/index.html deleted file mode 100644 index a18d619f28..0000000000 --- a/docs/zh-CN/1.3.2/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.2

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/blog.html b/docs/zh-CN/1.3.2/blog.html deleted file mode 100644 index 2a60137df4..0000000000 --- a/docs/zh-CN/1.3.2/blog.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.2

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/blog/index.html b/docs/zh-CN/1.3.2/blog/index.html deleted file mode 100644 index 2a60137df4..0000000000 --- a/docs/zh-CN/1.3.2/blog/index.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.2

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/commands.html b/docs/zh-CN/1.3.2/commands.html deleted file mode 100644 index 8a39071612..0000000000 --- a/docs/zh-CN/1.3.2/commands.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.2

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/commands/index.html b/docs/zh-CN/1.3.2/commands/index.html deleted file mode 100644 index 8a39071612..0000000000 --- a/docs/zh-CN/1.3.2/commands/index.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.2

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/custom-pages.html b/docs/zh-CN/1.3.2/custom-pages.html deleted file mode 100644 index e18a67fd1d..0000000000 --- a/docs/zh-CN/1.3.2/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.2

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/custom-pages/index.html b/docs/zh-CN/1.3.2/custom-pages/index.html deleted file mode 100644 index e18a67fd1d..0000000000 --- a/docs/zh-CN/1.3.2/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.2

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/doc-markdown.html b/docs/zh-CN/1.3.2/doc-markdown.html deleted file mode 100644 index bd5e1270b8..0000000000 --- a/docs/zh-CN/1.3.2/doc-markdown.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.2

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/doc-markdown/index.html b/docs/zh-CN/1.3.2/doc-markdown/index.html deleted file mode 100644 index bd5e1270b8..0000000000 --- a/docs/zh-CN/1.3.2/doc-markdown/index.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.2

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/installation.html b/docs/zh-CN/1.3.2/installation.html deleted file mode 100644 index 4512c7f3c3..0000000000 --- a/docs/zh-CN/1.3.2/installation.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.3.2

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/installation/index.html b/docs/zh-CN/1.3.2/installation/index.html deleted file mode 100644 index 4512c7f3c3..0000000000 --- a/docs/zh-CN/1.3.2/installation/index.html +++ /dev/null @@ -1,145 +0,0 @@ -Installation · Docusaurus

1.3.2

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. -

  3. npx docusaurus-init

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

-
    -
  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。
    2. -
  2. cd website
    3. -
  3. 重命名 blog-examples-from-docusaurus为 blog。
    4. -
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. -
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/navigation.html b/docs/zh-CN/1.3.2/navigation.html deleted file mode 100644 index b394a8113b..0000000000 --- a/docs/zh-CN/1.3.2/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.2

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/navigation/index.html b/docs/zh-CN/1.3.2/navigation/index.html deleted file mode 100644 index b394a8113b..0000000000 --- a/docs/zh-CN/1.3.2/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.2

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/publishing.html b/docs/zh-CN/1.3.2/publishing.html deleted file mode 100644 index f99079af81..0000000000 --- a/docs/zh-CN/1.3.2/publishing.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.2

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/publishing/index.html b/docs/zh-CN/1.3.2/publishing/index.html deleted file mode 100644 index f99079af81..0000000000 --- a/docs/zh-CN/1.3.2/publishing/index.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.2

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/search.html b/docs/zh-CN/1.3.2/search.html deleted file mode 100644 index a22a027f94..0000000000 --- a/docs/zh-CN/1.3.2/search.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.2

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/search/index.html b/docs/zh-CN/1.3.2/search/index.html deleted file mode 100644 index a22a027f94..0000000000 --- a/docs/zh-CN/1.3.2/search/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.2

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/site-config.html b/docs/zh-CN/1.3.2/site-config.html deleted file mode 100644 index 5422168111..0000000000 --- a/docs/zh-CN/1.3.2/site-config.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.2

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/site-config/index.html b/docs/zh-CN/1.3.2/site-config/index.html deleted file mode 100644 index 5422168111..0000000000 --- a/docs/zh-CN/1.3.2/site-config/index.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.2

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/site-creation.html b/docs/zh-CN/1.3.2/site-creation.html deleted file mode 100644 index 0571f32357..0000000000 --- a/docs/zh-CN/1.3.2/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.2

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/site-creation/index.html b/docs/zh-CN/1.3.2/site-creation/index.html deleted file mode 100644 index 0571f32357..0000000000 --- a/docs/zh-CN/1.3.2/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.2

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/site-preparation.html b/docs/zh-CN/1.3.2/site-preparation.html deleted file mode 100644 index c0b81427d8..0000000000 --- a/docs/zh-CN/1.3.2/site-preparation.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.3.2

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/site-preparation/index.html b/docs/zh-CN/1.3.2/site-preparation/index.html deleted file mode 100644 index c0b81427d8..0000000000 --- a/docs/zh-CN/1.3.2/site-preparation/index.html +++ /dev/null @@ -1,105 +0,0 @@ -Site Preparation · Docusaurus

1.3.2

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

-
-
    -
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • -
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • -
  • The website/pages directory contains example top-level pages for the site.
    • -
  • The website/static directory contains static assets used by the example site.
    • -
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • -
-

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/translation.html b/docs/zh-CN/1.3.2/translation.html deleted file mode 100644 index 35e3abe9ab..0000000000 --- a/docs/zh-CN/1.3.2/translation.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.3.2

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/translation/index.html b/docs/zh-CN/1.3.2/translation/index.html deleted file mode 100644 index 35e3abe9ab..0000000000 --- a/docs/zh-CN/1.3.2/translation/index.html +++ /dev/null @@ -1,269 +0,0 @@ -Translations & Localization · Docusaurus

1.3.2

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the circle.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml file:

-
machine:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
-
-test:
-  override:
-
-    - "true"
-
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/versioning.html b/docs/zh-CN/1.3.2/versioning.html deleted file mode 100644 index 2fbd4fd638..0000000000 --- a/docs/zh-CN/1.3.2/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.2

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.2/versioning/index.html b/docs/zh-CN/1.3.2/versioning/index.html deleted file mode 100644 index 2fbd4fd638..0000000000 --- a/docs/zh-CN/1.3.2/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.2

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/adding-blog.html b/docs/zh-CN/adding-blog.html deleted file mode 100644 index c3c1953a9e..0000000000 --- a/docs/zh-CN/adding-blog.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.3

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/adding-blog/index.html b/docs/zh-CN/adding-blog/index.html deleted file mode 100644 index c3c1953a9e..0000000000 --- a/docs/zh-CN/adding-blog/index.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

1.3.3

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/api-pages.html b/docs/zh-CN/api-pages.html deleted file mode 100644 index ea641c7af4..0000000000 --- a/docs/zh-CN/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.3

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/api-pages/index.html b/docs/zh-CN/api-pages/index.html deleted file mode 100644 index ea641c7af4..0000000000 --- a/docs/zh-CN/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

1.3.3

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/blog.html b/docs/zh-CN/blog.html deleted file mode 100644 index c86348a70e..0000000000 --- a/docs/zh-CN/blog.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.3

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/blog/index.html b/docs/zh-CN/blog/index.html deleted file mode 100644 index c86348a70e..0000000000 --- a/docs/zh-CN/blog/index.html +++ /dev/null @@ -1,165 +0,0 @@ -Adding a Blog · Docusaurus

1.3.3

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
\ No newline at end of file diff --git a/docs/zh-CN/commands.html b/docs/zh-CN/commands.html deleted file mode 100644 index f11787d28d..0000000000 --- a/docs/zh-CN/commands.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.3

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/commands/index.html b/docs/zh-CN/commands/index.html deleted file mode 100644 index f11787d28d..0000000000 --- a/docs/zh-CN/commands/index.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

1.3.3

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/custom-pages.html b/docs/zh-CN/custom-pages.html deleted file mode 100644 index ea91046122..0000000000 --- a/docs/zh-CN/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/custom-pages/index.html b/docs/zh-CN/custom-pages/index.html deleted file mode 100644 index ea91046122..0000000000 --- a/docs/zh-CN/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

1.3.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/doc-markdown.html b/docs/zh-CN/doc-markdown.html deleted file mode 100644 index dcb01fcb48..0000000000 --- a/docs/zh-CN/doc-markdown.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.3

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/doc-markdown/index.html b/docs/zh-CN/doc-markdown/index.html deleted file mode 100644 index dcb01fcb48..0000000000 --- a/docs/zh-CN/doc-markdown/index.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

1.3.3

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/installation.html b/docs/zh-CN/installation.html deleted file mode 100644 index 1232808996..0000000000 --- a/docs/zh-CN/installation.html +++ /dev/null @@ -1,153 +0,0 @@ -Installation · Docusaurus

1.3.3

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

-

安装 Docusaurus

-

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. Create a project, if none exists, and change your the directory to this project's root.

    -

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    -
    -

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    -
    3. -

  3. Run the Docusaurus installation script: npx docusaurus-init.

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the example website

-

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

-
    -

  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。

    2. -

  2. cd website

    3. -

  3. 重命名 blog-examples-from-docusaurus为 blog。

    4. -

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. -

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    -

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/installation/index.html b/docs/zh-CN/installation/index.html deleted file mode 100644 index 1232808996..0000000000 --- a/docs/zh-CN/installation/index.html +++ /dev/null @@ -1,153 +0,0 @@ -Installation · Docusaurus

1.3.3

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

-

安装 Docusaurus

-

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. Create a project, if none exists, and change your the directory to this project's root.

    -

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    -
    -

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    -
    3. -

  3. Run the Docusaurus installation script: npx docusaurus-init.

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the example website

-

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

-
    -

  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。

    2. -

  2. cd website

    3. -

  3. 重命名 blog-examples-from-docusaurus为 blog。

    4. -

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. -

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    -

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/navigation.html b/docs/zh-CN/navigation.html deleted file mode 100644 index a71b215b3b..0000000000 --- a/docs/zh-CN/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.3

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/navigation/index.html b/docs/zh-CN/navigation/index.html deleted file mode 100644 index a71b215b3b..0000000000 --- a/docs/zh-CN/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

1.3.3

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/next/adding-blog.html b/docs/zh-CN/next/adding-blog.html deleted file mode 100644 index 79a6175859..0000000000 --- a/docs/zh-CN/next/adding-blog.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

next

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/adding-blog/index.html b/docs/zh-CN/next/adding-blog/index.html deleted file mode 100644 index 79a6175859..0000000000 --- a/docs/zh-CN/next/adding-blog/index.html +++ /dev/null @@ -1,192 +0,0 @@ -Adding a Blog · Docusaurus

next

Translate

Adding a Blog

初始设置

-

To setup your site's blog, start by creating a blog directory within your repo's website directory.

-

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

-
headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-
-

添加文章

-

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

-

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

-
---
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: Introducing Docusaurus
----
-
-Lorem Ipsum...
-
-

顶部选项

-

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

-
    -
  • author - 作者署名的文本标签。
    • -
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • -
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • -
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • -
  • title - The blog post title.
    • -
-

摘要截取

-

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

-
---
-title: Truncation Example
----
-
-All this will be part of the blog post summary.
-
-Even this.
-
-<!--truncate-->
-
-But anything from here on down will not be.
-
-Not this.
-
-Or this.
-
-

修改侧边栏可见的文章数

-

默认情况下，侧边栏会显示最近的5篇文章。

-

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

-

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

-

例如：

-
blogSidebarCount: 'ALL';
-
-

Changing The Sidebar Title

-

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

-

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

-

例如：

-
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
-
-

RSS订阅

-

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML

-

-标签

-

- A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used. -

-

-社交按钮 -

-

- 如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。 -

-

-Advanced Topics -

-

-I want to run in "Blog Only" mode. -

-

- You can run your Docusaurus site without a landing page and instead have your blog load first. -

-

- To do this: -

-
    -
  1. - Create a file index.html in website/static/. -
    2. -
    <li>
-  Place the contents of the template below into <code>website/static/index.html</code>
-</li>
-
-<li>
-  Customize the <code>&lt;title&gt;</code> of <code>website/static/index.html</code>
-</li>
-
-<li>
-  Delete the dynamic landing page <code>website/pages/en/index.js</code>
-</li>
-
    -
-
-

- Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog. -

-
-

- You can use this template: -

- 
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
-    <script type="text/javascript">
-      window.location.href = 'blog/';
-    </script>
-    <title>Title of Your Blog</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
-  </body>
-</html>
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/api-pages.html b/docs/zh-CN/next/api-pages.html deleted file mode 100644 index a0abb75c4b..0000000000 --- a/docs/zh-CN/next/api-pages.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

next

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/api-pages/index.html b/docs/zh-CN/next/api-pages/index.html deleted file mode 100644 index a0abb75c4b..0000000000 --- a/docs/zh-CN/next/api-pages/index.html +++ /dev/null @@ -1,219 +0,0 @@ -Pages and Styles · Docusaurus

next

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

-

URLs for Pages

-

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 For example, the page for the website/pages/en/help.js file will be found at the URL ${baseUrl}en/help.js as well as the URL ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

-

Titles for Pages

-

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.title = 'My Custom Title';
-
-module.exports = MyPage;
-
-

Description for Pages

-

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

-

例如：

-
const React = require('react');
-
-class MyPage extends React.Component {
-  render() {
-    // ... your rendering code
-  }
-}
-
-MyPage.description = 'My Custom Description';
-
-module.exports = MyPage;
-
-

This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
-
-

Page Require Paths

-

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

-

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path '../core/CompLibrary.js'.

-

If you wish to use your own components inside the website directory, use process.cwd() which will refer to the website directory to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, 'process.cwd() + /core/mycomponent.js'.

-

Provided Components

-

Docusaurus provides the following components in CompLibrary:

-

CompLibrary.MarkdownBlock

-

A React component that parses markdown and renders to HTML.

-

例如：

-
const MarkdownBlock = CompLibrary.MarkdownBlock;
-
-<MarkdownBlock>
-  [Markdown syntax for a link](http://www.example.com)
-</MarkdownBlock>;
-
-

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

-

Props

- - - - - - - - - -
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
-

Example

-
<Container
-  padding={['bottom', 'top']}
-  background="light"
-  className="myCustomClass">
-  ...
-</Container>
-
-

CompLibrary.GridBlock

-

A React component to organize text and images.

-

Props

- - - - - - - - - - -
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
-

Content Object

- - - - - - - - - - - - -
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
-

Example

-
<GridBlock
-  align="center"
-  layout="threeColumn"
-  className="myCustomClass"
-  contents={[
-    {
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      content: 'Learn how to use this project',
-      image: siteConfig.baseUrl + 'img/learn.png',
-      imageAlt: 'Learn how to use this project',
-      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
-    },
-    {
-      title: 'Frequently Asked Questions',
-      content: 'Questions gathered from the community',
-      image: siteConfig.baseUrl + 'img/faq.png',
-      imageAlign: 'top',
-    },
-    {
-      title: 'More',
-      content: 'Lots of documentation is on this site',
-    },
-  ]}
-/>
-
-

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository for its website set-up.

-

Translating Strings

-

When translations are enabled, any pages inside website/pages/en will be translated for all enabled languages. URLs for non-English pages will use their language tags as specified in the languages.js file. E.g. The URL for a French page of website/pages/en/help.js would be found at ${baseUrl}fr/help.html.

-

When writing pages that you wish to translate, wrap any strings to be translated inside a <translate> tag. e.g.,

-
<p>
-  <translate>I like translations</translate>
-</p>
-
-

You can also provide an optional description attribute to provide context for translators. e.g,

-
<a href="/community">
-  <translate desc="Footer link to page referring to community GitHub and Slack">
-    Community
-  </translate>
-</a>
-
-

Add the following require statement as well:

-
const translate = require('../../server/translate.js').translate;
-
-

Note that this path is valid for files inside pages/en and should be adjusted accordingly if files are in different locations, as discussed above.

-

Using Static Assets

-

Static assets should be placed into the website/static directory. They can be accessed by their paths, excluding static. For example, if the site's baseUrl is /docusaurus/, an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

-

Styles

-

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

-

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

-

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/commands.html b/docs/zh-CN/next/commands.html deleted file mode 100644 index e4d19afe25..0000000000 --- a/docs/zh-CN/next/commands.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

next

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/commands/index.html b/docs/zh-CN/next/commands/index.html deleted file mode 100644 index e4d19afe25..0000000000 --- a/docs/zh-CN/next/commands/index.html +++ /dev/null @@ -1,183 +0,0 @@ -CLI Commands · Docusaurus

next

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

- -

从命令行运行

-

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

-
yarn run start
-
-

也可以使用 npm 调用相同的脚本:

-
npm run start
-
-

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

-

使用参数

-

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

-
yarn run start -- port 8080
-
-

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

-
npm run start -- --port 8080
-
-

配置

-

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

-

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

-

命令

-

<autogenerated_table_of_contents>

-
-

参考

-

docusaurus-build

-

别名︰ build。

- - - - - - - -
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
-

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

-

See also docusaurus-start.

-
-

docusaurus-examples

-

别名：examples

- - - - - - - -
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
-

Example

-
docusaurus-examples <feature>
-
-

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

-
-

docusaurus-发布

-

Alias: publish-gh-pages

-

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:

-

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

-
    -
  • GIT_USER: 与部署提交联系的 GIT 用户。
    • -
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • -
-

Example

-
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
-
-

The following environment variables are set by CircleCI during the build process.

-
    -
  • CIRCLE_BRANCH: 与触发 CI 运行的提交关联的 git 分支。
    • -
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • -
-

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

-
    -
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • -
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • -
-

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

-
-

docusaurus-rename-version

-

Alias: rename-version

-

Renames an existing version of the docs to a new version name.

- - - - - - - - -
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
-

Example

-
docusaurus-rename-version <currentVersion> <newVersion>
-
-

See the Versioning guide to learn more.

-
-

docusaurus-start

-

Alias: start.

-

This script will build the static website, apply translations if necessary, and then start a local server.

- - - - - - - - -
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
-
-

docusaurus-版本 <版本>

-

Alias: version

-

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

-

See the Versioning guide to learn more.

-
-

docusaurus-书写-翻译

-

Alias: write-translations

-

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/custom-pages.html b/docs/zh-CN/next/custom-pages.html deleted file mode 100644 index 1ee83353a9..0000000000 --- a/docs/zh-CN/next/custom-pages.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

next

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/custom-pages/index.html b/docs/zh-CN/next/custom-pages/index.html deleted file mode 100644 index 1ee83353a9..0000000000 --- a/docs/zh-CN/next/custom-pages/index.html +++ /dev/null @@ -1,114 +0,0 @@ -Custom Pages · Docusaurus

next

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

-

自定义您的主页

-

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

-

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

-

加入其它自定义页面

-

Docusaurus provides some simple example pages in the website/pages/en directory, including index.js, users.js, and help.js. These are good examples to showcase how to create a custom page for Docusaurus.

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    │   ├── index.js
-    │   ├── users.js
-    │   └── help.js
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

-
-

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

-
-

添加静态页面

-

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

-

If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

-
-

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

-
-

自定义您的页脚

-

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

-

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

-

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

-

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

-

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

-
const React = require('react');
-
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
-
-module.exports = Footer;
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/doc-markdown.html b/docs/zh-CN/next/doc-markdown.html deleted file mode 100644 index afdc643920..0000000000 --- a/docs/zh-CN/next/doc-markdown.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

next

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/doc-markdown/index.html b/docs/zh-CN/next/doc-markdown/index.html deleted file mode 100644 index afdc643920..0000000000 --- a/docs/zh-CN/next/doc-markdown/index.html +++ /dev/null @@ -1,198 +0,0 @@ -Markdown Features · Docusaurus

next

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

-

Markdown 标题

-

文档

-

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

-

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

-

title: The title of your document. If this field is not present, the document's title will default to its id.

-

hide_title: Whether to hide the title at the top of the doc.

-

sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to its title.

-

例如：

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
-
-

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

-

例如：

-
---
-id: version-1.0.0-doc1
-title: My Document
-sidebar_label: Document
-original_id: doc1
----
-
-

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

-

例如：

-
---
-id: doc-markdown
-title: Markdown Features
-custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
----
-
-

博客文章

-

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

-

tittle: 此博客文章的标题。

-

author: The author of this blog post. If this field is omitted, no author name will be shown.

-

authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.

-

authorFBID: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

-

例如：

-
---
-tittle: My First Blog Post
-author: Frank Li
-authorURL: http://twitter.com/franchementli
-authorFBID: 100002976521003
----
-
-

更多功能

-

Docusaurus 在markdown中编写文档时支持一些额外的功能。

-

链接到其他文档

-

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

-

例如：

-
[This links to another document](other-document.md)
-
-

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

-

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered.

-

链接到图像和其它资源

-

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

-

例如：

-
![alt-text](assets/doc-image.png)
-
-

生成目录

-

You can make an auto-generated list of links, which can be useful as a table of contents for API docs.

-

In your markdown file, insert a line with the text ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

-

例如：

-
### `docusaurus.function(a, b)`
-
-Text describing my function
-
-### `docdoc(file)`
-
-Text describing my function
-
-

这将会把页面带去这些功能的目录：

-
- `docusaurus.function(a, b)`
-- `docdoc(file)`
-
-

每个函数将会把链接带到页面相对应的部分。

-

Syntax Highlighting

-

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```js
-ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-```
-
-

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
-
-

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
{
-  ...
-  highlight: {
-    theme: 'default'
-  }
-  ...
-}
-
-

You can find the full list of supported themes in the Highlight.js styles directory.

-

Registering additional languages

-

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
{
-  ...
-  highlight: {
-    theme: 'default',
-    hljs: function(hljs) {
-      hljs.registerLanguage('galacticbasic', function(hljs) {
-        // ...
-      });
-    }
-  }
-}
-
-

Using Prism as additional syntax highlighter

-

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

-

例如：

-
// siteConfig.js
-usePrism: ['jsx']
-
-

Notice that the code block below uses JSX syntax highlighting from Prism.

-
class Example extends React.Component {
-  render() {
-    return (
-      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
-        <Text>Docusaurus</Text>
-        <Button
-          title="Click me"
-          onPress={() => this.props.navigation.push('Docusaurus')}
-        />
-      </View>
-    );
-  }
-}
-
-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/docker.html b/docs/zh-CN/next/docker.html deleted file mode 100644 index 31f52d71ca..0000000000 --- a/docs/zh-CN/next/docker.html +++ /dev/null @@ -1,115 +0,0 @@ -Docker · Docusaurus

next

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

-

Run the local webserver in docker

-

Ensure you have previously installed docker.

-

To run the local webserver:

-
    -

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    -

    Once the build phase finishes, you can verify the image exists by running docker images.

    -
    -

    We now include a Dockerfile when you install Docusaurus.

    -
    2. -

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    -

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. -
-

Use docker-compose

-

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

-
-

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

-
-

Using Compose is a three-step process:

-
    -

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. -

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. -

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. -
-

We include a basic docker-compose.yml in your project:

-
version: "3"
-
-services:
-  docusaurus:
-    build: .
-    ports:
-
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
-
-
-

To run a local webserver with docker-compose run docker-compose up.

-

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/docker/index.html b/docs/zh-CN/next/docker/index.html deleted file mode 100644 index 31f52d71ca..0000000000 --- a/docs/zh-CN/next/docker/index.html +++ /dev/null @@ -1,115 +0,0 @@ -Docker · Docusaurus

next

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

-

Run the local webserver in docker

-

Ensure you have previously installed docker.

-

To run the local webserver:

-
    -

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    -

    Once the build phase finishes, you can verify the image exists by running docker images.

    -
    -

    We now include a Dockerfile when you install Docusaurus.

    -
    2. -

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    -

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. -
-

Use docker-compose

-

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

-
-

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

-
-

Using Compose is a three-step process:

-
    -

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. -

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. -

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. -
-

We include a basic docker-compose.yml in your project:

-
version: "3"
-
-services:
-  docusaurus:
-    build: .
-    ports:
-
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
-
-
-

To run a local webserver with docker-compose run docker-compose up.

-

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/installation.html b/docs/zh-CN/next/installation.html deleted file mode 100644 index 9a26c653c5..0000000000 --- a/docs/zh-CN/next/installation.html +++ /dev/null @@ -1,153 +0,0 @@ -Installation · Docusaurus

next

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

-

安装 Docusaurus

-

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. Create a project, if none exists, and change your the directory to this project's root.

    -

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    -
    -

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    -
    3. -

  3. Run the Docusaurus installation script: npx docusaurus-init.

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the example website

-

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

-
    -

  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。

    2. -

  2. cd website

    3. -

  3. 重命名 blog-examples-from-docusaurus为 blog。

    4. -

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. -

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    -

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/installation/index.html b/docs/zh-CN/next/installation/index.html deleted file mode 100644 index 9a26c653c5..0000000000 --- a/docs/zh-CN/next/installation/index.html +++ /dev/null @@ -1,153 +0,0 @@ -Installation · Docusaurus

next

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

-

安装 Docusaurus

-

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

-
    -

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    -
    -

    You have to be on Node >= 8.x and Yarn >= 1.5.

    -
    2. -

  2. Create a project, if none exists, and change your the directory to this project's root.

    -

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    -
    -

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    -
    3. -

  3. Run the Docusaurus installation script: npx docusaurus-init.

    -
    -

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    -
    4. -
-

验证安装

-

Along with previously existing files and directories, your root directory will now contain a structure similar to:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-

Running the example website

-

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

-
    -

  1. 在根目录中, 重命名 docs-examples-from-docusaurus 为 docs。

    2. -

  2. cd website

    3. -

  3. 重命名 blog-examples-from-docusaurus为 blog。

    4. -

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. -

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    -

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. -
-

-

Launching the server behind a proxy

-

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

-
SET NO_PROXY=localhost
-yarn start (or npm run start)
-
-

Updating Your Docusaurus Version

-

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

-

You will see something like this:

-
$ yarn outdated
-Using globally installed version of Yarn
-yarn outdated v1.5.1
-warning package.json: No license field
-warning No license field
-info Color legend : 
- "<red>"    : Major Update backward-incompatible updates 
- "<yellow>" : Minor Update backward-compatible features 
- "<green>"  : Patch Update backward-compatible bug fixes
-Package    Current Wanted Latest Package Type    URL                                          
-docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
-✨  Done in 0.41s.
-
-
-

If there is no noticeable version output from the outdated commands, then you are up-to-date.

-
-

You can update to the latest version of Docusaurus by:

-
yarn upgrade docusaurus --latest
-
-

或

-
npm update docusaurus
-
-
-

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

-
-
下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/navigation.html b/docs/zh-CN/next/navigation.html deleted file mode 100644 index 8ce6f3bf38..0000000000 --- a/docs/zh-CN/next/navigation.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

next

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/next/navigation/index.html b/docs/zh-CN/next/navigation/index.html deleted file mode 100644 index 8ce6f3bf38..0000000000 --- a/docs/zh-CN/next/navigation/index.html +++ /dev/null @@ -1,231 +0,0 @@ -Navigation and Sidebars · Docusaurus

next

Translate

Navigation and Sidebars

Referencing Site Documents

-

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

-

For example, if you are in doc2.md and you want to reference doc1.md:

-
I am referencing a [document](doc1.md).
-
-

How Documents are Linked

-

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

-

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

-

Suppose you add this to your document:

-
---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
-

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

-
-

You need an id field to be able to add the document to the sidebar.

-
-

Adding Documents to a Sidebar

-

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

-
-

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

-
-

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

-
-

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

-
-

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

-
{
-  "docs": {
-    "Getting Started": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

或者您也可以在边栏中创建一个新类别:

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

However, for a document located in a docs subdirectory like below:

-
docs
-└── dir1
-    └── getting-started.md
-
-

You should provide directory/id instead of id in sidebars.json.

-
{
-  "docs": {
-    "My New Sidebar Category": [
-      "dir1/getting-started"
-    ],
-    ...
-  },
-  ...
-}
-
-

Adding New Sidebars

-

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

-
{
-  "examples-sidebar": {
-    "My Example Category": [
-      "my-examples"
-    ],
-    ...
-  },
-  ...
-}
-
-

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

-

Additions to the Site Navigation Bar

-

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

-

Adding Documents

-

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

-
{
-  headerLinks: [
-    ...
-    { doc: 'my-examples', label: 'Examples' },
-    ...
-  ],
-  ...
-}
-
-

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

-

Adding Custom Pages

-

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

-
{
-  headerLinks: [
-    ...
-    { page: 'help', label: 'Help' },
-    ...
-  ],
-  ...
-}
-
-

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

-

Adding External Links

-

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

-
{
-  headerLinks: [
-    ...
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-
-

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

-
-

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

-
-

Site Navigation Bar Positioning

-

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

-

Search

-

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { search: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Languages Dropdown

-

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

-
{
-  headerLinks: [
-    { doc: 'foo', label: 'Foo' },
-    { languages: true },
-    { doc: 'bar', label: 'Bar' },
-  ],
-  ...
-}
-
-

Active Links In Site Navigation Bar

-

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

-
-

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

-
-

The siteNavGroupActive class will be added to these links:

-
    -
  • doc links that belong to the same sidebar as the currently displayed document
    • -
  • The blog link when a blog post, or the blog listing page is being displayed
    • -
-

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

-

Secondary On-Page Navigation

-

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

-
{
-  onPageNav: 'separate',
-  ...
-}
-
-

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

-
← 上一页翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/next/publishing.html b/docs/zh-CN/next/publishing.html deleted file mode 100644 index 9d21c04066..0000000000 --- a/docs/zh-CN/next/publishing.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

next

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/publishing/index.html b/docs/zh-CN/next/publishing/index.html deleted file mode 100644 index 9d21c04066..0000000000 --- a/docs/zh-CN/next/publishing/index.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

next

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/search.html b/docs/zh-CN/next/search.html deleted file mode 100644 index 52337eec1b..0000000000 --- a/docs/zh-CN/next/search.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

next

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/search/index.html b/docs/zh-CN/next/search/index.html deleted file mode 100644 index 52337eec1b..0000000000 --- a/docs/zh-CN/next/search/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

next

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-config.html b/docs/zh-CN/next/site-config.html deleted file mode 100644 index 26d86480ff..0000000000 --- a/docs/zh-CN/next/site-config.html +++ /dev/null @@ -1,276 +0,0 @@ -siteConfig.js · Docusaurus

next

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

enableUpdateTime - An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last Updated: dd/mm/yyyy hh:MM:ss Z.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

manifest - Path to your web app manifest (e.g., /manifest.json). This will add a <link> tag to <head> with rel as "manifest" and content as the provided path.

-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: [
-    'https://docusaurus.io/slash.js',
-    {
-      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
-      async: true
-    }
-  ],
-  stylesheets: [
-    'https://docusaurus.io/style.css',
-    {
-      href: 'http://css.link',
-      type: "text/css"
-    }
-  ],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/next/site-config/index.html b/docs/zh-CN/next/site-config/index.html deleted file mode 100644 index 26d86480ff..0000000000 --- a/docs/zh-CN/next/site-config/index.html +++ /dev/null @@ -1,276 +0,0 @@ -siteConfig.js · Docusaurus

next

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

enableUpdateTime - An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last Updated: dd/mm/yyyy hh:MM:ss Z.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

manifest - Path to your web app manifest (e.g., /manifest.json). This will add a <link> tag to <head> with rel as "manifest" and content as the provided path.

-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: [
-    'https://docusaurus.io/slash.js',
-    {
-      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
-      async: true
-    }
-  ],
-  stylesheets: [
-    'https://docusaurus.io/style.css',
-    {
-      href: 'http://css.link',
-      type: "text/css"
-    }
-  ],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/next/site-creation.html b/docs/zh-CN/next/site-creation.html deleted file mode 100644 index ee9b487d77..0000000000 --- a/docs/zh-CN/next/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

next

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-creation/index.html b/docs/zh-CN/next/site-creation/index.html deleted file mode 100644 index ee9b487d77..0000000000 --- a/docs/zh-CN/next/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

next

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-preparation.html b/docs/zh-CN/next/site-preparation.html deleted file mode 100644 index 04471cefe6..0000000000 --- a/docs/zh-CN/next/site-preparation.html +++ /dev/null @@ -1,111 +0,0 @@ -Site Preparation · Docusaurus

next

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

-
-

Directory Descriptions

-
    -
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • -
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • Pages: The website/pages directory contains example top-level pages for the site.
    • -
  • Static files and images: The website/static directory contains static assets used by the example site.
    • -
-

Key Files

-
    -
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • -
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • -
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • -
-

Preparation Notes

-

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-preparation/index.html b/docs/zh-CN/next/site-preparation/index.html deleted file mode 100644 index 04471cefe6..0000000000 --- a/docs/zh-CN/next/site-preparation/index.html +++ /dev/null @@ -1,111 +0,0 @@ -Site Preparation · Docusaurus

next

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

-
-

Directory Descriptions

-
    -
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • -
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • Pages: The website/pages directory contains example top-level pages for the site.
    • -
  • Static files and images: The website/static directory contains static assets used by the example site.
    • -
-

Key Files

-
    -
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • -
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • -
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • -
-

Preparation Notes

-

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/translation.html b/docs/zh-CN/next/translation.html deleted file mode 100644 index 32db43b52e..0000000000 --- a/docs/zh-CN/next/translation.html +++ /dev/null @@ -1,291 +0,0 @@ -Translations & Localization · Docusaurus

next

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "docs": {
-      "id": {
-        "title": "string1",
-        "sidebar_label": "string2"
-      },
-      "version-0.0.1-id": {
-        "title": "string3",
-        "sidebar_label": "string4"
-      }
-    }
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the .circleci/config.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example .circleci/config.yml file:

-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            # install Docusaurus and generate file of English strings
-            - cd website && yarn install && yarn run write-translations && cd ..
-            # crowdin install
-            - sudo apt-get install default-jre
-            - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-            - sudo dpkg -i crowdin.deb
-            # translations upload/download
-            - crowdin --config crowdin.yaml upload sources --auto-update -b master
-            - crowdin --config crowdin.yaml download -b master
-            # build and publish website
-            cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/translation/index.html b/docs/zh-CN/next/translation/index.html deleted file mode 100644 index 32db43b52e..0000000000 --- a/docs/zh-CN/next/translation/index.html +++ /dev/null @@ -1,291 +0,0 @@ -Translations & Localization · Docusaurus

next

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "docs": {
-      "id": {
-        "title": "string1",
-        "sidebar_label": "string2"
-      },
-      "version-0.0.1-id": {
-        "title": "string3",
-        "sidebar_label": "string4"
-      }
-    }
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the .circleci/config.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example .circleci/config.yml file:

-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            # install Docusaurus and generate file of English strings
-            - cd website && yarn install && yarn run write-translations && cd ..
-            # crowdin install
-            - sudo apt-get install default-jre
-            - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-            - sudo dpkg -i crowdin.deb
-            # translations upload/download
-            - crowdin --config crowdin.yaml upload sources --auto-update -b master
-            - crowdin --config crowdin.yaml download -b master
-            # build and publish website
-            cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/versioning.html b/docs/zh-CN/next/versioning.html deleted file mode 100644 index 161fc4f634..0000000000 --- a/docs/zh-CN/next/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

next

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/next/versioning/index.html b/docs/zh-CN/next/versioning/index.html deleted file mode 100644 index 161fc4f634..0000000000 --- a/docs/zh-CN/next/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

next

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/publishing.html b/docs/zh-CN/publishing.html deleted file mode 100644 index 6d5eca413f..0000000000 --- a/docs/zh-CN/publishing.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.3

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/publishing/index.html b/docs/zh-CN/publishing/index.html deleted file mode 100644 index 6d5eca413f..0000000000 --- a/docs/zh-CN/publishing/index.html +++ /dev/null @@ -1,260 +0,0 @@ -Publishing your site · Docusaurus

1.3.3

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

-

构建静态 HTML 页

-

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

-
yarn 运行 `build` # 或者 `npm run build`
-
-

这将在 网站 目录中生成一个 "生成" 目录, 其中包含 页 中包含的所有文档和其他页中所含的. html ` 文件。

-

构建静态 HTML 页

-

At this point, you can grab all of the files inside the website/build` directory and copy them over to your favorite web server's `html` directory. -

-

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

-

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

-
-

Hosting on a Service:

- -

Using GitHub Pages

-

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

-

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

-
-

Even if your repository is private, anything published to a gh-pages branch will be public.

-
-

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

- - - - - - - - -
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
-
-

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username".
-For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

-

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

-
-

One of the required parameters is set as a environment variable:

- - - - - - - -
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
-

There are also two optional parameters that are set as environment variables:

- - - - - - - - -
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
-

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

-

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-
GIT_USER=<GIT_USER> \
-  CURRENT_BRANCH=master \
-  USE_SSH=true \
-  yarn run publish-gh-pages # or `npm run publish-gh-pages`
-
-
-

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

-
-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

-

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

-

However, you can automate the publishing process with continuous integration (CI).

-

Automating Deployments Using Continuous Integration

-

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using Circle CI, a popular continuous integration service provider.

-

Using Circle CI 2.0

-

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

-
    -
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. -
  2. Log into GitHub as the GIT_USER.
    3. -
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. -
  4. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. -
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. -
  6. Create a .circleci directory and create a config.yml under that directory.
    7. -
  7. Copy the text below into .circleci/config.yml.
    8. -
-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

-

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

-
-

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

-

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

-
-

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-
-

If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI instructions for adding a read/write deploy key.

-
-

Tips & Tricks

-

When initially deploying to a gh-pages branch using Circle CI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents:

-
# Circle CI 2.0 Config File
-# This config file will prevent tests from being run on the gh-pages branch.
-version: 2
-jobs:
-  build:
-    machine: true
-    branches:
-      ignore: gh-pages
-    steps:
-      - run: echo "Skipping tests on gh-pages branch"
-
-

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

-

Using Travis CI

-
    -
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. -
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. -
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. -
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. -
  5. Create a .travis.yml on the root of your repository with below text.
    6. -
-
# .travis.yml
-language: node_js
-node_js:
-  - '8'
-branches:
-  only:
-    - master
-cache:
-  yarn: true
-script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
-

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

-

Hosting on Netlify

-

Steps to configure your Docusaurus-powered site on Netlify.

-
    -

  1. Select New site from Git

    2. -

  2. Connect to your preferred Git provider.

    3. -

  3. Select the branch to deploy. Default is master

    4. -

  4. Configure your build steps:

    -
      -
    • For your build command enter: cd website; npm install; npm run build;
      • -
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • -
    5. -

  5. 单击 ** 部署站点 **

    6. -
-

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

-

Publishing to GitHub Enterprise

-

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

- - - - - - - -
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
-

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/search.html b/docs/zh-CN/search.html deleted file mode 100644 index b489891cbf..0000000000 --- a/docs/zh-CN/search.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.3

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/search/index.html b/docs/zh-CN/search/index.html deleted file mode 100644 index b489891cbf..0000000000 --- a/docs/zh-CN/search/index.html +++ /dev/null @@ -1,112 +0,0 @@ -Enabling Search · Docusaurus

1.3.3

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

-

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

-

启用搜索框

-

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

-
const siteConfig = {
-  ...
-  algolia: {
-    apiKey: 'my-api-key',
-    indexName: 'my-index-name',
-    algoliaOptions: {} // Optional, if provided by Algolia
-  },
-  ...
-};
-
-

Extra Search Options

-

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

-
const siteConfig = {    
-  ...   
-  algolia: {    
-    ... 
-    algoliaOptions: {   
-      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
-    }   
-  },    
-};  
-
-

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

-

Controlling the Location of the Search Bar

-

By default, the search bar will be the rightmost element in the top navigation bar.

-

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

-
const siteConfig = {
-  ...
-  headerLinks: [
-    {...}
-    {...}
-    { search: true }
-    {...}
-    {...}
-  ],
-  ...
-};
-
-

Disabling the Search Bar

-

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

-

Also, if you have customized the location of the search bar in headerLinks, set search: false.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/site-config.html b/docs/zh-CN/site-config.html deleted file mode 100644 index 8696077a93..0000000000 --- a/docs/zh-CN/site-config.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.3

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/site-config/index.html b/docs/zh-CN/site-config/index.html deleted file mode 100644 index 8696077a93..0000000000 --- a/docs/zh-CN/site-config/index.html +++ /dev/null @@ -1,262 +0,0 @@ -siteConfig.js · Docusaurus

1.3.3

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

-

用户展示

-

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

-

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

-

siteConfig 属性

-

siteConfig 对象包含了网站的大部分配置。

-

必填属性

-

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

-

colors - 网站的颜色。

-
    -
  • primaryColor 标题导航栏和侧边栏的颜色。
    • -
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • -
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • -
-

copyright - 网站页脚和信息流中的版权声明。

-

favicon - URL for site favicon.

-

headerIcon - URL for icon used in header navigation bar.

-

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

-

示例用法：

-
headerLinks: [
-  // Links to document with id doc1 for current language/version
-  { doc: "doc1", label: "Getting Started" },
-  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
-  { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
-  // Links to blog generated by Docusaurus (${baseUrl}blog)
-  { blog: true, label: "Blog" },
-  // Determines search bar position among links
-  { search: true },
-  // Determines language drop down position among links
-  { languages: true }
-],
-
-

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

-

tagline - 网站标语。

-

title - 网站标题。

-

url - URL for your website.

-

可选属性

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

-
    -
  • apiKey - the Algolia provided API key for your search.
    • -
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • -
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • -
-

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

-

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

-

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

-

cname - The CNAME for your website. It will go into a CNAME file when your site is built.

-

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

-
customDocsPath: 'docs/site';
-
-
customDocsPath: 'website-docs';
-
-

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

-

disableHeaderTitle - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

editUrl - URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

-

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

-

facebookPixelId - Facebook Pixel ID to track page views.

-

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

-

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

-
fonts: {
-  myFont: [
-    'Times New Roman',
-    'Serif'
-  ],
-  myOtherFont: [
-    '-apple-system',
-    'system-ui'
-  ]
-},
-
-

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

-
h1 {
-  font-family: $myFont;
-}
-
-

footerIcon - URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

gaTrackingId - Google Analytics tracking ID to track page views.

-

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

-

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

-

highlight - Syntax highlighting options:

-
    -
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • -
  • version specifies a particular version of Highlight.js to be used.
    • -
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • -
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • -
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • -
-

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

-

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

- -

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

-

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

-

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

-

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

-

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

translationRecruitingLink - URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

-

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

-

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

users - The users array mentioned earlier.

-

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

-

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

-

Users can also add their own custom fields if they wish to provide some data across different files.

-

Example siteConfig.js with many available fields

-
const users = [
-  {
-    caption: 'User1',
-    image: '/test-site/img/docusaurus.svg',
-    infoLink: 'https://www.example.com',
-    pinned: true,
-  },
-];
-
-const siteConfig = {
-  title: 'Docusaurus',
-  tagline: 'Generate websites!',
-  url: 'https://docusaurus.io',
-  baseUrl: '/',
-  // For github.io type URLS, you would combine the URL and baseUrl like:
-  // url: 'https://reasonml.github.io',
-  // baseUrl: '/reason-react/',
-  defaultVersionShown: '1.0.0',
-  organizationName: 'facebook',
-  projectName: 'docusaurus',
-  noIndex: false,
-  // For no header links in the top nav bar -> headerLinks: [],
-  headerLinks: [
-    {doc: 'doc1', label: 'Docs'},
-    {page: 'help', label: 'Help'},
-    {search: true},
-    {blog: true},
-  ],
-  headerIcon: 'img/docusaurus.svg',
-  favicon: 'img/favicon.png',
-  colors: {
-    primaryColor: '#2E8555',
-    secondaryColor: '#205C3B',
-  },
-  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
-  // Users variable set above
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
-  footerIcon: 'img/docusaurus.svg',
-  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
-  algolia: {
-    apiKey: '0f9f28b9ab9efae89810921a351753b5',
-    indexName: 'github',
-  },
-  gaTrackingId: 'UA-12345678-9',
-  highlight: {
-    theme: 'default',
-  },
-  markdownPlugins: [
-    function foo(md) {
-      md.renderer.rules.fence_custom.foo = function(
-        tokens,
-        idx,
-        options,
-        env,
-        instance
-      ) {
-        return '<div class="foo">bar</div>';
-      };
-    },
-  ],
-  scripts: ['https://docusaurus.io/slash.js'],
-  stylesheets: ['https://docusaurus.io/style.css'],
-  facebookAppId: '1615782811974223',
-  facebookComments: true,
-  facebookPixelId: '352490515235776',
-  twitter: 'true',
-  twitterUsername: 'docusaurus',
-  twitterImage: 'img/docusaurus.png',
-  ogImage: 'img/docusaurus.png',
-  cleanUrl: true,
-  scrollToTop: true,
-  scrollToTopOptions: {
-    zIndex: 100,
-  },
-};
-
-module.exports = siteConfig;
-
-
← 上一页
\ No newline at end of file diff --git a/docs/zh-CN/site-creation.html b/docs/zh-CN/site-creation.html deleted file mode 100644 index 3327ecbad9..0000000000 --- a/docs/zh-CN/site-creation.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.3

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/site-creation/index.html b/docs/zh-CN/site-creation/index.html deleted file mode 100644 index 3327ecbad9..0000000000 --- a/docs/zh-CN/site-creation/index.html +++ /dev/null @@ -1,143 +0,0 @@ -Creating your site · Docusaurus

1.3.3

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

-

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Site Structure

-

Your site structure looks like the following:

-
root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

This assumes that you removed the example .md files that were installed with the initialization script.

-
-

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

-
-

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

-
-

Create Your Basic Site

-

To create a fully functional site, you only need to do a few steps:

-
    -

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.

    -
    ---
-id: intro
-title: Getting Started
----
-
-My new content here..
-
    2. -

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. -
-
-

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

-
-
    -
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. -
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. -
  3. Place assets, such as images, in the website/static/ directory.
    4. -
  4. Run the site to see the results of your changes.
    5. -
-
cd website
-yarn run start # or `npm run start`
-# Navigate to http://localhost:3000
-
-

Special Customization

-

Docs Landing Page

-

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

-
    -
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. -
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. -
-
<!DOCTYPE HTML>
-<html lang="en-US">
-  <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
-    <script type="text/javascript">
-      window.location.href = 'docs/id-of-doc-to-land-on.html';
-    </script>
-    <title>Your Site Title Here</title>
-  </head>
-  <body>
-    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
-  </body>
-</html>
-
-
-

You will get the id of the document to land on the .md metadata of that doc page.

-
-

Blog Only

-

You can also use Docusaurus to host your blog only.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/site-preparation.html b/docs/zh-CN/site-preparation.html deleted file mode 100644 index 7d8a33ccc2..0000000000 --- a/docs/zh-CN/site-preparation.html +++ /dev/null @@ -1,111 +0,0 @@ -Site Preparation · Docusaurus

1.3.3

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

-
-

Directory Descriptions

-
    -
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • -
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • Pages: The website/pages directory contains example top-level pages for the site.
    • -
  • Static files and images: The website/static directory contains static assets used by the example site.
    • -
-

Key Files

-
    -
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • -
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • -
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • -
-

Preparation Notes

-

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/site-preparation/index.html b/docs/zh-CN/site-preparation/index.html deleted file mode 100644 index 7d8a33ccc2..0000000000 --- a/docs/zh-CN/site-preparation/index.html +++ /dev/null @@ -1,111 +0,0 @@ -Site Preparation · Docusaurus

1.3.3

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

-

目录结构

-

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

-
root-directory
-├── docs-examples-from-docusaurus
-│   ├── doc1.md
-│   ├── doc2.md
-│   ├── doc3.md
-│   ├── exampledoc4.md
-│   └── exampledoc5.md
-└── website
-    ├── blog-examples-from-docusaurus
-    │   ├── 2016-03-11-blog-post.md
-    │   ├── 2017-04-10-blog-post-two.md
-    │   ├── 2017-09-25-testing-rss.md
-    │   ├── 2017-09-26-adding-rss.md
-    │   └── 2017-10-24-new-version-1.0.0.md
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-
-
-

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

-
-

Directory Descriptions

-
    -
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • -
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • -
  • Pages: The website/pages directory contains example top-level pages for the site.
    • -
  • Static files and images: The website/static directory contains static assets used by the example site.
    • -
-

Key Files

-
    -
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • -
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • -
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • -
-

Preparation Notes

-

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

-

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/translation.html b/docs/zh-CN/translation.html deleted file mode 100644 index de283c5c97..0000000000 --- a/docs/zh-CN/translation.html +++ /dev/null @@ -1,283 +0,0 @@ -Translations & Localization · Docusaurus

1.3.3

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the .circleci/config.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example .circleci/config.yml file:

-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            # install Docusaurus and generate file of English strings
-            - cd website && yarn install && yarn run write-translations && cd ..
-            # crowdin install
-            - sudo apt-get install default-jre
-            - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-            - sudo dpkg -i crowdin.deb
-            # translations upload/download
-            - crowdin --config crowdin.yaml upload sources --auto-update -b master
-            - crowdin --config crowdin.yaml download -b master
-            # build and publish website
-            cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/translation/index.html b/docs/zh-CN/translation/index.html deleted file mode 100644 index de283c5c97..0000000000 --- a/docs/zh-CN/translation/index.html +++ /dev/null @@ -1,283 +0,0 @@ -Translations & Localization · Docusaurus

1.3.3

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

-

Docusaurus 翻译配置

-

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

-
npm 运行示例翻译
-
-

或

-
yarn运行示例翻译
-
-

这会创建以下文件:

-
pages/en/help-with-translations.js
-languages.js
-../crowdin.yaml
-
-
    -
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • -
-
-

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

-
-
    -

  • The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

    • -

  • The crowdin.yaml file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

    • -
-

翻译现有文档

-

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

-

在页面上启用翻译

-

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

-

Pages with text that you want translated should be placed in website/pages/en directory.

-

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

-
...
-const translate = require('../../server/translate.js').translate;
-...
-<h2>
-  <translate>This header will be translated</translate>
-</h2>
-...
-
-

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

-
<p>
-  <translate desc="flower, not verb">Rose</translate>
-<p>
-
-
-

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

-
-

收集字符串以进行转换

-

有本地化页面的字符串必须提取出并提供给Crowdin。

-

Add the following script to your website/package.json file, if it does not exist already:

-
{
-  ...
-  "scripts": {
-    "write-translations": "docusaurus-write-translations"
-  },
-  ...
-}
-
-

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

-

该脚本将包含在以下位置的文本:

-
    -
  • title 和 sidebar_label 在markdown标题中的字符串
    • -
  • sidebars. json 中的种类名称
    • -
  • 在siteConfig.js中的标语
    • -
  • siteConfig 里的标题链接 label 字符串
    • -
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • -
-

Custom Translation Strings

-

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

-
{
-  "localized-strings": {
-    "id": "string",
-    "id2": "string2"
-  },
-  "pages-strings" : {
-    "id3": "string3",
-    "id4": "string4"
-  }
-}
-
-

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

-

Here is an example:

-
{
-  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
-  "localized-strings": {
-    "translation": "Translations and Localization"
-  },
-  "pages-strings" : {
-        "Help Translate|recruit community translators for your project": "Help Us Translate"
-  }
-}
-
-

See the generated website/i18n/en.json for an example.

-

字符串是怎么转换的

-

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

-

Docusaurus怎样使用字符串翻译

-

这部分提供Docusaurus中的翻译是怎么工作的上下文

-

字符串

-

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 Docusaurus simplifies this by centralizing strings.

-

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

-

Markdown Files

-

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

-

Other Pages

-

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

-

Crowdin

-

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations.

-

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

-
-

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

-
-

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

-
-

You will need to install the crowdin command line interface. Please follow the installation directions.

-
-

The example below can be automatically generated by the Docusaurus cli with the examples script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.

-

Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.

-
project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
-api_key_env: CROWDIN_DOCUSAURUS_API_KEY
-base_path: "./"
-preserve_hierarchy: true
-
-files:
-  -
-    source: '/docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-CN'
-        'zh-TW': 'zh-TW'
-
-

You can go here to learn more about customizing your crowdin.yaml file.

-

Setup the Crowdin Scripts

-

You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs as well as translatable strings in website/i18n/en.json. (These strings can be generated by running yarn write-translations.)

-

You can add the following to your package.json to manually trigger Crowdin.

-
"scripts": {
-  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
-  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
-},
-
-

Manual File Sync

-

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

-
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
-CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
-
-
-

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

-

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done above or add them permanently to your .bashrc or .bash_profile.

-

If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

-

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

-
-

Automated File Sync Using CircleCI

-

You can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.

-

First, update the .circleci/config.yml file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example .circleci/config.yml file:

-
# If you only want circle to run on direct commits to master, you can uncomment this out
-# and uncomment the filters: *filter-only-master down below too
-#
-# aliases:
-#  - &filter-only-master
-#    branches:
-#      only:
-#        - master
-
-version: 2
-jobs:
-  deploy-website:
-    docker:
-      # specify the version you desire here
-
-      - image: circleci/node:8.11.1
-
-    steps:
-
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
-            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
-            git config --global user.name "<YOUR_NAME>"
-            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
-            # install Docusaurus and generate file of English strings
-            - cd website && yarn install && yarn run write-translations && cd ..
-            # crowdin install
-            - sudo apt-get install default-jre
-            - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-            - sudo dpkg -i crowdin.deb
-            # translations upload/download
-            - crowdin --config crowdin.yaml upload sources --auto-update -b master
-            - crowdin --config crowdin.yaml download -b master
-            # build and publish website
-            cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
-#         filters: *filter-only-master
-
-

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

-

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

-

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

-

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

-

Versioned Translations

-

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

-
  -
-    source: '/website/versioned_docs/**/*.md'
-    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
-    languages_mapping: *anchor
-
-

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

-
← 上一页下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/versioning.html b/docs/zh-CN/versioning.html deleted file mode 100644 index b4e409dbde..0000000000 --- a/docs/zh-CN/versioning.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.3

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/versioning/index.html b/docs/zh-CN/versioning/index.html deleted file mode 100644 index b4e409dbde..0000000000 --- a/docs/zh-CN/versioning/index.html +++ /dev/null @@ -1,124 +0,0 @@ -Versioning · Docusaurus

1.3.3

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

-

如何创建新版本

-

Run the following script to generate a starter versions page listing all the site versions:

-
yarn examples versions
-
-

This creates the pages/en/versions.js file.

-

You can edit this file later on to customize how you display the versions.

-

Add the following script to your package.json file if it doesn't already exist:

-
...
-"scripts": {
-  "version": "docusaurus-version"
-},
-...
-
-

Run the script with a command line argument of the version you wish to create. e.g.,

-
yarn run version 1.0.0
-
-

This will preserve all documents currently in the docs directory and make them available as documentation for version 1.0.0.

-

If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.

-

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

-

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

-

This table below summarizes Docusaurus versioning at a glance:

- - - - - - - - - - -
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
-

Versioning Patterns

-

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

-

Storing Files for Each Version

-

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

-

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

-

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

-

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

-

If you wish to change the documentation for a past version, you can access the files for that respective version.

-

Fallback Functionality

-

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

-

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

-

Renaming Existing Versions

-

To rename an existing version number to something else, first make sure the following script is in your package.json file:

-
...
-"scripts": {
-  "rename-version": "docusaurus-rename-version"
-},
-...
-
-

Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,

-
yarn run rename-version 1.0.0 1.0.1
-
-

Versioning and Translations

-

If you wish to use versioning and translations features, the crowdin.yaml file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

-
← 翻译和本地化下一页 →
\ No newline at end of file diff --git a/zh-CN/about-slash.html b/zh-CN/about-slash.html index b1d69efede..68968b9eaa 100644 --- a/zh-CN/about-slash.html +++ b/zh-CN/about-slash.html @@ -1,4 +1,4 @@ -About Slash · Docusaurus

1.3.3

About Slash

Docusaurus

Slash is the official mascot of Docusaurus. You will find different variations of her throughout the website, whether she is moving fast on her scooter or writing documentation at her standing desk. At Facebook, we have actual Slash plushies -- and you never know, you may see these plushies at various events and conferences in the future.

Birth of Slash

Birth of Slash

The team sat in a conference room trying to come up with a name for the project. Dinosaurs became a theme, finally landing on Docusaurus, combining documentation with those many dinosaurs that end in "saurus". Of course, we needed a logo for our new project. Eric sat down and designed a logo that was quite beyond the norm of our normal open source project logos, but yet was just so awesome, we had to use it. We needed a name for this cute Docusaur. "Marky" for markdown? "Docky" for documentation? No, "Slash" for the normal way someone starts code documentation in many programming languages // or /* or ///. And Slash was born.