commit f06089439435d6afb7a4474bff6cc1bc35136fc2 Author: Facebook GitHub Bot Date: Thu Aug 17 00:37:54 2017 +0000 update website [ci skip] diff --git a/CNAME b/CNAME new file mode 100644 index 0000000000..c8e1959e2a --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docusaurus.io \ No newline at end of file diff --git a/css/main.css b/css/main.css new file mode 100644 index 0000000000..35f415ac6a --- /dev/null +++ b/css/main.css @@ -0,0 +1,1960 @@ +/* Reset */ +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +b, u, i, center, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td, +article, aside, canvas, details, embed, +figure, figcaption, footer, header, hgroup, +menu, nav, output, ruby, section, summary, +time, mark, audio, video { + margin: 0; + padding: 0; + border: 0; + font-size: 100%; + font: inherit; + vertical-align: baseline; +} +/* HTML5 display-role reset for older browsers */ +article, aside, details, figcaption, figure, +footer, header, hgroup, menu, nav, section { + display: block; +} +body { + line-height: 1; +} +ol, ul { + list-style: none; +} +blockquote, q { + quotes: none; +} +blockquote:before, blockquote:after, +q:before, q:after { + content: ''; + content: none; +} +table { + border-collapse: collapse; + border-spacing: 0; +} + +/* Base */ + +body { + background: #f9f9f9; + color: #393939; + font: normal 16px/1.4em "Helvetica Neue", Arial, sans-serif; + height: 100vh; + text-align: left; + text-rendering: optimizeLegibility; +} + +img { + max-width: 100%; +} + +article p img { + max-width: 100%; + display: block; + margin-left: auto; + margin-right: auto; +} + +a { + color: #2E8555; + text-decoration: none; +} + +a.anchor { + display: block; + position: relative; + top: -62px; +} + +a.hash-link { + opacity: 0; + transition: opacity 0.3s; +} +h1:hover a.hash-link, +h2:hover a.hash-link, +h3:hover a.hash-link, +h4:hover a.hash-link { + opacity: 0.5; +} +a.hash-link:hover { + opacity: 1!important; +} + +blockquote { + padding: 15px 30px 15px 15px; + margin: 20px 0 0 10px; + background-color: rgba(204, 122, 111, 0.1); + border-left: 10px solid rgba(191, 87, 73, 0.2); +} + +#fb_oss a { + border: 0; +} + +h1, h2, h3, h4 { + font-family: "Helvetica Neue", Arial, sans-serif; + font-weight: 300; + color: #2E8555; +} + +header h2 { + color: white; + font-size: 20px; +} + +.homeContainer { + background: #fff; + color: #2E8555; + text-align: center; +} + +.homeContainer .homeWrapper { + padding: 2em 10px; +} +.homeContainer .homeWrapper .wrapper { + margin: 0px auto; + max-width: 900px; + padding: 0 20px; +} +.homeContainer .homeWrapper .projectLogo img { + height: 100px; + margin-bottom: 0px; +} +.homeContainer .homeWrapper h1#project_title { + font-family: "Helvetica Neue", Arial, sans-serif; + font-size: 300%; + letter-spacing: -0.08em; + line-height: 1em; + margin-bottom: 80px; +} +.homeContainer .homeWrapper h2#project_tagline { + font-family: "Helvetica Neue", Arial, sans-serif; + font-size: 200%; + letter-spacing: -0.04em; + line-height: 1em; +} + +.wrapper { + margin: 0px auto; + max-width: 1024px; + padding: 0 10px; +} + +.projectLogo { + display: none; + pointer-events: none; +} +.projectLogo img { + height: 100px; + margin-bottom: 0px; +} + +.projectIntro { + margin: 40px 0; +} + +.fbossFontLight { + font-family: "Helvetica Neue", Arial, sans-serif; + font-weight: 300; + font-style: normal; +} + +.fb-like { + display: block; + margin-bottom: 20px; + width: 100%; +} +.center { + display: block; + text-align: center; +} + +.mainContainer { + background: #f9f9f9; + flex: 1; +} +.mainContainer .wrapper { + text-align: left; +} +.mainContainer .wrapper .allShareBlock { + padding: 10px 0; +} +.mainContainer .wrapper .allShareBlock .pluginBlock { + margin: 12px 0; + padding: 0; +} +.mainContainer .wrapper a, +.inner .projectIntro a { + text-decoration: underline; +} +.mainContainer .wrapper a:hover, +.mainContainer .wrapper a:focus, +.inner .projectIntro a:hover, +.inner .projectIntro a:focus { + text-decoration: none; +} +.mainContainer .wrapper em, .mainContainer .wrapper i { + font-style: italic; +} +.mainContainer .wrapper strong, .mainContainer .wrapper b { + font-weight: bold; +} +.container .wrapper h1 { + font-size: 300%; + line-height: 1em; + margin: 0 0 10px 0; + padding: 1.4em 0 1em; + text-align: left; +} +.container .wrapper h2 { + color: #2E8555; + font-size: 22px; + line-height: 1em; + margin-top: 20px; + text-align: left; + padding: 10px 0; +} +.container .wrapper h2.blockHeader { + color: white; + font-size: 22px; + margin-top: 20px; + padding: 10px 0; +} +.container .wrapper h3 { + color: #2E8555; + font-size: 18px; + margin-top: 10px; + padding: 10px 0; +} +.container .wrapper h4 { + color: #2E8555; + font-size: 16px; + font-weight: 300; + margin: 0; + padding: 10px 0 0; +} +.referenceContainer .wrapper h3 { + border-top: 1px solid #e0e0e0; +} +.referenceContainer .wrapper h3:first-of-type { + border: 0; +} +.container .wrapper h4 + p { + padding-top: 0; +} +.mainContainer .wrapper p, +.blockElement p { + padding: 0.8em 0; +} +.mainContainer .wrapper ul { + list-style: disc; +} +.mainContainer .wrapper ol, .mainContainer .wrapper ul { + padding: 10px 0 10px 24px; +} +.mainContainer .wrapper ol li, .mainContainer .wrapper ul li { + padding-bottom: 4px; +} +.mainContainer .wrapper strong { + font-weight: bold; +} +.mainContainer .wrapper .post { + position: relative; +} +.mainContainer .wrapper .post.basicPost { + margin-top: 30px; +} +.mainContainer .wrapper .post h2 { + font-size: 130%; +} +.mainContainer .wrapper .post h3 { + font-size: 110%; +} +.mainContainer .wrapper .post h5 { + font-weight: 300; + font-style: italic; +} +.mainContainer .wrapper .post h5 strong { + font-weight: 400; +} +.mainContainer .wrapper .post ol { + list-style: decimal outside none; +} +.mainContainer .wrapper .post .postHeader { + padding: 2em 0 0; +} +.mainContainer .wrapper .post .postHeader h1 { + font-size: 150%; + line-height: 1em; + padding: 0.4em 0 0; +} +.mainContainer .wrapper .post .postHeader h1 a { + border: none; +} +.mainContainer .wrapper .post .postHeader .post-meta { + text-align: center; +} +.mainContainer .wrapper .post .postSocialPlugins { + padding-top: 1em; +} +.mainContainer .wrapper .post .docPagination { + background: #2E8555; + bottom: 0px; + left: 0px; + position: absolute; + right: 0px; +} +.mainContainer .wrapper .post .docPagination .pager { + display: inline-block; + width: 50%; +} +.mainContainer .wrapper .post .docPagination .pagingNext { + float: right; + text-align: right; +} +.mainContainer .wrapper .post .docPagination a { + border: none; + color: #fff; + display: block; + padding: 4px 12px; +} +.mainContainer .wrapper .post .docPagination a:hover { + background-color: #f9f9f9; + color: #393939; +} +.mainContainer .wrapper .post .docPagination a .pagerLabel { + display: inline; +} +.mainContainer .wrapper .post .docPagination a .pagerTitle { + display: none; +} +.mainContainer .wrapper .posts .post { + margin-bottom: 6vh; +} + +#integrations_title { + font-size: 250%; + margin: 80px 0; +} + +.ytVideo { + height: 0; + overflow: hidden; + padding-bottom: 53.4%; + /* 16:9 */ + padding-top: 25px; + position: relative; +} + +.ytVideo iframe, +.ytVideo object, +.ytVideo embed { + height: 100%; + left: 0; + position: absolute; + top: 0; + width: 100%; +} + +.projectTitle { + font-size: 250%; + line-height: 1em; + font-weight: 400; +} + +.projectTitle > small { + display: block; + font-size: 50%; + line-height: 1em; + font-weight: 300; + margin: 0.7em 0 1.3em; +} + +@media only screen and (min-width: 480px) { + h1#project_title { + font-size: 500%; + } + + .projectTitle { + font-size: 300%; + margin: 0.3em 0; + } + + .projectTitle > small { + font-size: 50%; + } + + .projectLogo img { + margin-bottom: 10px; + height: 200px; + } + + .homeContainer .homeWrapper { + padding-left: 10px; + padding-right: 10px; + } + + .mainContainer .wrapper .post h2 { + font-size: 180%; + } + .mainContainer .wrapper .post h3 { + font-size: 120%; + } + .mainContainer .wrapper .post .docPagination a .pagerLabel { + display: none; + } + .mainContainer .wrapper .post .docPagination a .pagerTitle { + display: inline; + } +} +@media only screen and (min-width: 900px) { + .homeContainer .homeWrapper { + position: relative; + } + .homeContainer .homeWrapper #inner { + box-sizing: border-box; + max-width: 600px; + padding-right: 40px; + } +} +@media only screen and (min-width: 1024px) { + .mainContainer .wrapper .post { + box-sizing: border-box; + display: block; + } + .mainContainer .wrapper .post .postHeader h1 { + font-size: 250%; + } + .mainContainer .wrapper .posts .post { + margin-bottom: 4vh; + width: 100%; + } +} +@media only screen and (min-width: 1200px) { + .homeContainer .homeWrapper #inner { + max-width: 750px; + } + + .wrapper { + max-width: 1100px; + } + .homeContainer .homeWrapper .projectLogo { + align-items: center; + bottom: 0; + display: flex; + justify-content: flex-end; + left: 0; + padding: 2em 100px 4em; + position: absolute; + right: 0; + top: 0; + } + .homeContainer .homeWrapper .projectLogo img { + height: 100%; + max-height: 250px; + } +} +@media only screen and (min-width: 1500px) { + .homeContainer .homeWrapper #inner { + max-width: 1100px; + padding-bottom: 40px; + padding-top: 40px; + } + + .wrapper { + max-width: 1400px; + } +} +.fixedHeaderContainer { + box-sizing: border-box; + background: #2E8555; + color: #fff; + height: 50px; + padding: 10px 0 8px; + position: fixed; + width: 100%; + z-index: 9999; +} +.fixedHeaderContainer a { + align-items: center; + border: 0; + color: #fff; + display: flex; + flex-flow: row nowrap; + height: 34px; + z-index: 10000; +} +.fixedHeaderContainer header { + display: flex; + flex-flow: row nowrap; + position: relative; + text-align: left; +} +.fixedHeaderContainer header img { + height: 100%; + margin-right: 10px; +} +.fixedHeaderContainer header h2 { + display: block; + font-family: "Helvetica Neue", Arial, sans-serif; + font-weight: 400; + line-height: 18px; + position: relative; + z-index: 9999; +} +.fixedHeaderContainer header h3 { + text-decoration: underline; + font-family: "Helvetica Neue", Arial, sans-serif; + color: white; + margin-left: 10px; + font-size: 16px; +} + +.promoSection { + display: flex; + flex-flow: column wrap; + font-size: 125%; + line-height: 1.6em; + position: relative; + z-index: 99; +} +.promoSection .promoRow { + padding: 10px 0; +} +.promoSection .promoRow .pluginWrapper { + display: block; +} +.promoSection .promoRow .pluginWrapper.ghWatchWrapper, .promoSection .promoRow .pluginWrapper.ghStarWrapper { + height: 28px; +} +.promoSection .promoRow .pluginRowBlock { + display: flex; + flex-wrap: wrap; + justify-content: center; + margin: 0 -2px; +} +.promoSection .promoRow .pluginRowBlock .pluginWrapper { + padding: 0 2px; +} +.promoSection .promoRow .pluginRowBlock iframe { + margin-left: 2px; + margin-top: 5px; +} +.button { + margin: 4px; + border: 1px solid #2E8555; + border-radius: 3px; + color: #2E8555; + display: inline-block; + font-size: 14px; + font-weight: 400; + line-height: 1.2em; + padding: 10px; + text-transform: uppercase; + text-decoration: none !important; + transition: background 0.3s, color 0.3s; +} +.button:hover { + background: #2E8555; + color: #fff; +} + +.blockButton { + display: block; +} + +/** Search **/ +input[type="search"] { + -moz-appearance: none; + -webkit-appearance: none; +} + +.navSearchWrapper { + align-self: center; + position: absolute; + top: 15px; + right: 10px; +} +.navSearchWrapper::before { + border: 3px solid #e5e5e5; + border-radius: 50%; + content: " "; + display: block; + height: 6px; + left: 15px; + width: 6px; + position: absolute; + top: 50%; + z-index: 1; + transform: translateY(-58%); +} +.navSearchWrapper::after { + background: #e5e5e5; + content: " "; + height: 7px; + left: 24px; + position: absolute; + transform: rotate(-45deg); + top: 55%; + width: 3px; + z-index: 1; +} +.navSearchWrapper .aa-dropdown-menu { + background: #f9f9f9; + border: 3px solid rgba(57, 57, 57, 0.25); + color: #393939; + font-size: 14px; + left: auto !important; + line-height: 1.2em; + right: 0 !important; +} +.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--category-header { + background: #2E8555; + color: white; + font-family: "Helvetica Neue", Arial, sans-serif; + font-weight: 400; + font-size: 14px; +} +.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight { + background-color: #2E8555; + color: #fff; +} +.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--title .algolia-docsearch-suggestion--highlight, +.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight { + color: #2E8555; +} +.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion__secondary, +.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--subcategory-column { + border-color: rgba(57, 57, 57, 0.3); +} +input#search_input_react { + padding-left: 25px; + font-size: 14px; + font-family: "Helvetica Neue", Arial, sans-serif; + font-weight: 300; + line-height: 20px; + border-radius: 20px; + background-color: rgba(0, 0, 0, 0.2); + border: none; + color: #fff; + outline: none; + position: relative; + width: 170px; + transition: .5s width ease; + -webkit-transition: .5s width ease; + -moz-transition: .5s width ease; + -o-transition: .5s width ease; +} +input#search_input_react:focus, input#search_input_react:active { + color: #fff; + width: 220px; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .navSearchWrapper { + width: 50%; + } +} +input::-webkit-input-placeholder { + color: #e5e5e5; +} + +input::-moz-placeholder { + color: #e5e5e5; +} + +input::placeholder { + color: #e5e5e5; +} + +code, +a code, +.mainContainer .wrapper a code, +.mainContainer .wrapper a:focus code { + color: #2E8555; + font-family: Hack, monospace; + font-size: 90%; + font-weight: 300; +} +a code { + text-decoration: underline; +} +a:hover code { + text-decoration: none; +} + +.prism { + white-space: pre-wrap; + font-family: 'source-code-pro', Menlo, 'Courier New', Consolas, monospace; + font-size: 13px; + line-height: 20px; + border-left: 4px solid #2E8555; + overflow-x: scroll; + -webkit-overflow-scrolling: touch; + padding: 5px 10px; + margin: 14px 0 14px 20px; + background-color: rgba(46, 133, 85, 0.03); +} + +.prism + .prism { + margin-top: 14px; +} +.prism table { + background: none; + border: none; +} +.prism table tbody tr { + background: none; + display: flex; + flex-flow: row nowrap; +} +.highlighter-rouge .prism table tbody tr td { + display: block; + flex: 1 1; +} +.highlighter-rouge .prism table tbody tr td.gutter { + border-right: 1px solid #005469; + color: #006883; + margin-right: 10px; + max-width: 40px; + padding-right: 10px; +} +.highlighter-rouge .prism table tbody tr td.gutter pre { + max-width: 20px; +} +/* Inline code */ +:not(pre) > code[class*="language-"] { + padding: .1em; + border-radius: .3em; + white-space: normal; +} + +.token.comment, +.token.prolog, +.token.doctype, +.token.cdata { + color: slategray; +} + +.token.punctuation { + color: #999; +} + +.namespace { + opacity: .7; +} + +.token.property, +.token.tag, +.token.boolean, +.token.number, +.token.constant, +.token.symbol, +.token.deleted { + color: #905; +} + +.token.selector, +.token.attr-name, +.token.string, +.token.char, +.token.builtin, +.token.inserted { + color: #690; +} + +.token.operator, +.token.entity, +.token.url, +.language-css .token.string, +.style .token.string { + color: #a67f59; + background: hsla(0, 0%, 100%, .5); +} + +.token.atrule, +.token.attr-value, +.token.keyword { + color: #07a; +} + +.token.function { + color: #DD4A68; +} + +.token.regex, +.token.important, +.token.variable { + color: #e90; +} + +.token.important, +.token.bold { + font-weight: bold; +} +.token.italic { + font-style: italic; +} + +.token.entity { + cursor: help; +} + +/** GitHub **/ +.edit-page-link { + float: right; + font-size: 10px; + font-weight: normal; + margin-top: 20px; + text-decoration: none; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .edit-page-link { + display: none; + } +} +/** GridBlock **/ +.gridBlock { + margin: -5px 0; + padding: 0; +} +.gridBlock .twoByGridBlock, +.gridBlock .threeByGridBlock, +.gridBlock .fourByGridBlock { + padding: 5px 0; +} +.gridBlock .twoByGridBlock img, +.gridBlock .threeByGridBlock img, +.gridBlock .fourByGridBlock img { + max-width: 100%; +} +.gridBlock .gridClear { + clear: both; +} +.alignCenter { + text-align: center; +} +.alignRight { + text-align: right; +} +.imageAlignSide { + display: flex; + flex-flow: row wrap; +} +.blockImage { + max-width: 730px; +} +.imageAlignSide .blockImage { + max-width: 500px; + flex: 0 1 500px; + margin-right: 40px; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .imageAlignSide .blockImage { + display: none; + } +} +.imageAlignSide .blockContent { + flex: 1 1; +} +.imageAlignBottom .blockImage { + max-width: 730px; + margin: 0 auto 20px; +} +.imageAlignBottom.alignCenter .blockImage { + margin-left: auto; + margin-right: auto; +} +.imageAlignTop .blockImage { + max-width: 80px; + margin-bottom: 20px; +} +.imageAlignTop.alignCenter .blockImage { + margin-left: auto; + margin-right: auto; +} +.container .gridBlock .blockContent p { + padding: 0; +} +.highlightBackground { + background: rgba(153, 66, 79, 0.7); + color: #fff; +} +.highlightBackground a { + border-color: white; + color: #fff; + font-weight: 800; +} +.container.highlightBackground .wrapper h1, +.container.highlightBackground .wrapper h2, +.container.highlightBackground .wrapper h3, +.container.highlightBackground .wrapper h4, +.container.highlightBackground .wrapper h5 { + border-color: white; + color: white; +} +.lightBackground { + background: #e9e9e9; +} +.darkBackground { + background: #808080; + color: #fff; +} +.darkBackground a { + color: #d6b3b8; +} +.darkBackground code { + color: #d6b3b8; +} +.container.darkBackground .wrapper h1, +.container.darkBackground .wrapper h2, +.container.darkBackground .wrapper h3, +.container.darkBackground .wrapper h4, +.container.darkBackground .wrapper h5 { + border-color: white; + color: white; +} +.container.paddingAll { + padding: 40px; +} +.container.paddingBottom { + padding-bottom: 80px; +} +.container.paddingLeft { + padding-left: 40px; +} +.container.paddingRight { + padding-right: 40px; +} +.container.paddingTop { + padding-top: 80px; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .container.paddingBottom { + padding-bottom: 40px; + } + .container.paddingTop { + padding-top: 20px; + } +} +@media only screen and (max-width: 1023px) { + .responsiveList .blockContent { + position: relative; + } + .responsiveList .blockContent > div { + padding-left: 20px; + } + .responsiveList .blockContent::before { + content: "\2022"; + position: absolute; + } +} +@media only screen and (min-width: 1024px) { + .gridBlock { + display: flex; + flex-direction: row; + flex-wrap: wrap; + margin: -10px; + } + .gridBlock .twoByGridBlock { + box-sizing: border-box; + flex: 1 0 50%; + padding: 10px; + } + .gridBlock .threeByGridBlock { + box-sizing: border-box; + flex: 1 0 26%; + padding: 10px; + } + .gridBlock .fourByGridBlock { + box-sizing: border-box; + flex: 1 0 25%; + padding: 10px; + } + + h2 + .gridBlock { + padding-top: 20px; + } +} +@media only screen and (min-width: 1400px) { + .gridBlock { + display: flex; + flex-direction: row; + flex-wrap: wrap; + margin: -10px -20px; + } + .gridBlock .twoByGridBlock { + box-sizing: border-box; + flex: 1 0 50%; + padding: 10px 20px; + } + .gridBlock .threeByGridBlock { + box-sizing: border-box; + flex: 1 0 26%; + padding: 10px; + } + .gridBlock .fourByGridBlock { + box-sizing: border-box; + flex: 1 0 25%; + padding: 10px 20px; + } +} +.navigationSlider .navSlideout { + cursor: pointer; + padding-top: 4px; + position: absolute; + right: 10px; + top: 0; + transition: top 0.3s; + z-index: 101; +} +.navigationSlider .slidingNav { + box-sizing: border-box; + position: absolute; + left: -10px; + right: -10px; + top: -10px; + bottom: auto; +} +.navigationSlider .slidingNav.slidingNavActive { + height: auto; + padding-top: 42px; + width: 300px; +} +.navigationSlider .slidingNav ul { + box-sizing: border-box; + display: flex; + flex-wrap: nowrap; + list-style: none; + margin-top: 50px; + width: 100%; + padding: 0; + background: #205C3B; + color: #fff; +} +.navigationSlider .slidingNav.slidingNavActive ul { + display: block; +} +.navigationSlider .slidingNav ul li { + flex: 1; + text-align: center; + white-space: nowrap; + margin: 0; +} +.navigationSlider .slidingNav ul li a { + color: #2E8555; + display: flex; + align-items: center; + justify-content: center; + margin: 0; + height: auto; + color: inherit; + transition: background-color 0.3s; + height: 50px; + padding: 10px; + box-sizing: border-box; + font-size: 0.9em; +} +.navigationSlider .slidingNav ul li a:focus, +.navigationSlider .slidingNav ul li a:hover { + background: #2E8555; +} + +.languages-icon { + width: 20px; +} +#languages-dropdown { + position: absolute; + width:100%; +} +#languages-dropdown.visible { + display: flex; +} +#languages-dropdown.hide { + display: none; +} +ul#languages-dropdown-items { + display: flex; + background-color: #2E8555; + flex-direction: column; + min-width: 120px; +} + +ul#languages li { + display: block; +} + +.menuExpand { + display: flex; + flex-flow: column nowrap; + height: 20px; + justify-content: space-between; +} +.menuExpand span { + background: #fff; + border-radius: 3px; + display: block; + flex: 0 0 4px; + height: 4px; + position: relative; + top: 0; + transition: background-color 0.3s, top 0.3s, opacity 0.3s, transform 0.3s; + width: 20px; +} +.navPusher { + padding-top: 100px; + position: relative; + left: 0; + z-index: 99; + height: 100%; +} +.navPusher::after { + position: absolute; + top: 0; + right: 0; + width: 0; + height: 0; + background: rgba(0, 0, 0, 0.4); + content: ''; + opacity: 0; + -webkit-transition: opacity 0.5s, width 0.1s 0.5s, height 0.1s 0.5s; + transition: opacity 0.5s, width 0.1s 0.5s, height 0.1s 0.5s; +} + +@media only screen and (min-width: 1024px) { + .navPusher { + padding-top: 50px; + } +} +.sliderActive .navPusher::after { + width: 100%; + height: 100%; + opacity: 1; + -webkit-transition: opacity 0.5s; + transition: opacity 0.5s; + z-index: 100; +} +@media only screen and (max-width: 1023px) { + .reactNavSearchWrapper::before { + left: 6px; + } + .reactNavSearchWrapper::after { + left: 15px; + } + .reactNavSearchWrapper input#search_input_react { + box-sizing: border-box; + padding-left: 25px; + font-size: 14px; + line-height: 20px; + border-radius: 20px; + background-color: rgba(242, 196, 178, 0.25); + border: none; + color: #393939; + outline: none; + position: relative; + transition: background-color 0.2s cubic-bezier(0.68, -0.55, 0.265, 1.55), width 0.2s cubic-bezier(0.68, -0.55, 0.265, 1.55), color 0.2s ease; + width: 100%; + } + .reactNavSearchWrapper input#search_input_react:focus, .reactNavSearchWrapper input#search_input_react:active { + background-color: #2E8555; + color: #fff; + } + .reactNavSearchWrapper .algolia-docsearch-suggestion--subcategory-inline { + display: none; + } + .reactNavSearchWrapper > span { + width: 100%; + } + .reactNavSearchWrapper .aa-dropdown-menu { + background: #f9f9f9; + border: 0px solid #f9f9f9; + color: #393939; + font-size: 12px; + line-height: 2em; + max-height: 140px; + min-width: auto; + overflow-y: scroll; + -webkit-overflow-scrolling: touch; + padding: 0; + border-radius: 0; + position: relative !important; + width: 100%; + } + + #languages-dropdown { + top: 50px; + left: 0px; + } + + ul#languages-dropdown-items { + display: flex; + background-color: #2E8555; + flex-direction: row; + } +} +@media only screen and (min-width: 1024px) { + .navSearchWrapper { + position: relative; + top: auto; + right: auto; + padding-left: 10px; + } + .navSearchWrapper .algolia-autocomplete { + display: block; + } + .navigationSlider { + height: 34px; + margin-left: auto; + position: relative; + } + .navigationSlider .navSlideout { + display:none; + } + .navigationSlider nav.slidingNav { + background: none; + height: auto; + position: relative; + right: auto; + top: auto; + width: auto; + } + .navigationSlider .slidingNav ul { + display: flex; + flex-flow: row nowrap; + margin: 0 -10px; + padding: 0; + background: none; + width: auto; + } + .navigationSlider .slidingNav ul li a { + border: 0; + color: rgba(255, 255, 255, 0.8); + display: flex; + margin: 0; + padding: 0; + font-size: 16px; + font-weight: 300; + line-height: 1.2em; + padding: 6px 10px; + height: 32px; + font-size: 1em; + } + .navigationSlider .slidingNav ul li a:hover { + color: #fff; + } + .navigationSlider .slidingNav ul li.navItemActive a { + color: #fff; + } +} +.algolia-autocomplete { + bottom: 10px; +} + +.docs-prevnext { + margin: 20px 0; +} +.docs-next { + float: right; +} +.docs-prev { + float: left; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .docs-prevnext { + height: 40px; + } + .docs-prev { + display: none; + } +} + +.docsNavContainer { + background: #c6c6c6; + height: 35px; + left: 0; + position: fixed; + width: 100%; + z-index: 100; +} +.docMainWrapper .wrapper { + padding-left: 0; + padding-right: 0; + padding-top: 10px; +} + +.docsSliderActive.docsNavContainer { + box-sizing: border-box; + height: 100%; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + padding-bottom: 50px; +} + +.docsNavContainer nav.toc .navBreadcrumb { + box-sizing: border-box; + display: flex; + flex-flow: row nowrap; + font-size: 12px; + height: 35px; + overflow: hidden; + padding: 5px 10px; +} +.navBreadcrumb a, .navBreadcrumb span { + border: 0; + color: #393939; +} +.navBreadcrumb i { + padding: 0 3px; +} +nav.toc { + width: 224px; +} +nav.toc section { + padding: 0px; + position: relative; +} +nav.toc:last-child { + padding-bottom: 100px; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + nav.toc { + width: 100%; + } + nav.toc:last-child { + padding-bottom: 0; + } +} +.docsNavContainer nav.toc .navWrapper { + padding: 0; +} +nav.toc section .navGroups { + display: none; + padding: 40px 10px 60px; +} +nav.toc .toggleNav { + background: #c6c6c6; + color: #393939; + position: relative; + transition: background-color 0.3s, color 0.3s; +} +nav.toc .toggleNav .navToggle { + cursor: pointer; + height: 24px; + margin-right: 10px; + position: relative; + text-align: left; + width: 18px; +} +nav.toc .toggleNav .navToggle::before, nav.toc .toggleNav .navToggle::after { + content: ""; + position: absolute; + top: 50%; + left: 0; + left: 8px; + width: 3px; + height: 6px; + border: 5px solid #393939; + border-width: 5px 0; + margin-top: -8px; + transform: rotate(45deg); + z-index: 1; +} +nav.toc .toggleNav .navToggle::after { + transform: rotate(-45deg); +} +nav.toc .toggleNav .navToggle i::before, nav.toc .toggleNav .navToggle i::after { + content: ""; + position: absolute; + top: 50%; + left: 2px; + background: transparent; + border-width: 0 5px 5px; + border-style: solid; + border-color: transparent #393939; + height: 0; + margin-top: -7px; + opacity: 1; + width: 5px; + z-index: 10; +} +nav.toc .toggleNav .navToggle i::after { + border-width: 5px 5px 0; + margin-top: 2px; +} +.docsSliderActive nav.toc .toggleNav .navToggle::before, +.docsSliderActive nav.toc .toggleNav .navToggle::after { + border-width: 6px 0; + height: 0px; + margin-top: -6px; +} +.docsSliderActive nav.toc .toggleNav .navToggle i { + opacity: 0; +} +nav.toc .toggleNav .navGroup { + background: #adadad; + margin: 1px 0; +} +nav.toc .toggleNav .navGroup ul { + display: none; +} +nav.toc .toggleNav .navGroup h3 { + background: #adadad; + color: #393939; + font-size: 14px; + font-weight: 400; + line-height: 1.2em; + margin: 0; + padding: 10px; + transition: color 0.2s; +} +nav.toc .toggleNav .navGroup h3 i:not(:empty) { + width: 16px; + height: 16px; + display: inline-block; + box-sizing: border-box; + text-align: center; + color: rgba(57, 57, 57, 0.5); + margin-right: 10px; + transition: color 0.2s; +} +nav.toc .toggleNav .navGroup h3:hover { + color: #2E8555; +} +nav.toc .toggleNav .navGroup h3:hover i:not(:empty) { + color: #2E8555; +} +nav.toc .toggleNav .navGroup.navGroupActive { + background: #e0e0e0; + color: #393939; +} +nav.toc .toggleNav .navGroup.navGroupActive ul { + display: block; + padding-bottom: 10px; + padding-top: 10px; +} +nav.toc .toggleNav .navGroup.navGroupActive h3 { + background: #2E8555; + color: #fff; +} +nav.toc .toggleNav ul { + padding-left: 0; + padding-right: 24px; +} +nav.toc .toggleNav ul li { + list-style-type: none; + padding-bottom: 0; + padding-left: 0; +} +nav.toc .toggleNav ul li a { + border: none; + color: #393939; + display: inline-block; + font-size: 14px; + line-height: 1.1em; + margin: 2px 10px 5px; + padding: 5px 0 2px; + transition: color 0.3s; +} +nav.toc .toggleNav ul li a:hover, nav.toc .toggleNav ul li a:focus { + color: #2E8555; +} +nav.toc .toggleNav ul li a.navItemActive { + color: #2E8555; + font-weight: 600; +} +.docsSliderActive nav.toc .navBreadcrumb { + background: #c6c6c6; + margin-bottom: 20px; + position: fixed; + width: 100%; +} +nav.toc .toggleNav .navBreadcrumb h2 { + border: 0; + font-size: inherit; + line-height: inherit; + margin: 0; + padding: 1px 0 0; +} +.docsSliderActive nav.toc section .navGroups { + display: block; +} + +.sideNavVisible .navPusher .mainContainer { + padding-top: 35px; +} + +@media only screen and (min-width: 900px) { + nav.toc section .navGroups { + padding: 40px 0 0; + } +} +@media only screen and (min-width: 1024px) { + .navToggle { + display: none; + } + + .docsSliderActive .mainContainer { + display: block; + } + + .sideNavVisible .navPusher .mainContainer { + padding-top: 0; + } + + .docsNavContainer { + background: none; + box-sizing: border-box; + height: auto; + margin: 40px 40px 0 0; + overflow-y: auto; + position: relative; + width: 300px; + } + + nav.toc section .navGroups { + display: block; + padding-top: 0px; + } + + .docMainWrapper { + display: flex; + flex-flow: row nowrap; + margin-bottom: 50px; + /*margin-bottom: -90px*/ + } + .docMainWrapper .wrapper { + padding-left: 0; + padding-right: 0; + } + .docMainWrapper .wrapper { + padding-top: 0; + } + + .docsNavContainer nav.toc .navBreadcrumb { + display: none; + } + .navBreadcrumb h2 { + padding: 0 10px; + } +} +table { + background: #F8F8F8; + border: 1px solid #B0B0B0; + border-collapse: collapse; + display: table; + margin: 20px 0; +} +table thead { + border-bottom: 1px solid #B0B0B0; + display: table-header-group; +} +table tbody { + display: table-row-group; +} +table tr { + display: table-row; +} +table tr:nth-of-type(odd) { + background: #E8E8E8; +} +table tr th, table tr td { + border-right: 1px dotted #B0B0B0; + display: table-cell; + font-size: 14px; + line-height: 1.3em; + padding: 10px; + text-align: left; +} +table tr th:last-of-type, table tr td:last-of-type { + border-right: 0; +} +table tr th code, table tr td code { + color: #2db04b; + display: inline-block; + font-size: 12px; +} +table tr th { + color: #000000; + font-weight: bold; + font-family: "Helvetica Neue", Arial, sans-serif; + text-transform: uppercase; +} + +.blogContainer .posts { + margin-top: 60px; +} +.blogContainer .posts .post { + border-bottom: 1px solid #e0e0e0; + border-radius: 3px; + padding: 0 10px 20px; +} +.blogContainer .lonePost { + margin-top: 60px; +} +.blogContainer .postHeader h1 { + text-align: center; +} +.blogContainer .postHeader a { + text-decoration: none; +} +.blogContainer .postHeader p.post-meta { + padding: 0; +} + +.blogContainer .postHeader .post-authorName { + color: rgba(57, 57, 57, 0.7); + font-size: 14px; + font-weight: 400; + margin-top: 0; + padding: 0; + text-align: center; +} +.blogContainer .postHeader .authorPhoto { + border-radius: 50%; + height: 70px; + margin: 0 auto; + overflow: hidden; + width: 70px; +} +.blog-recent { + margin: 20px 0; +} +.blog-recent > a { + float: left; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .blog-recent { + height: 40px; + } +} + +.header-link { + position: absolute; + margin-left: 0.2em; + opacity: 0; + -webkit-transition: opacity 0.2s ease-in-out 0.1s; + -moz-transition: opacity 0.2s ease-in-out 0.1s; + -ms-transition: opacity 0.2s ease-in-out 0.1s; +} + +h2:hover .header-link, +h3:hover .header-link, +h4:hover .header-link, +h5:hover .header-link, +h6:hover .header-link { + opacity: 1; +} + +/** Homepage **/ +.container .wrapper .alignCenter h2 { + text-align: center; +} +.container .wrapper .imageAlignSide h2 { + text-align: left; +} +.container .wrapper .imageAlignSide p { + margin-bottom: 40px; + max-width: 560px; + margin: 0; +} +.more-users { + max-width: 560px; + margin: 0 auto; + text-align: center; +} +.poweredByContainer { + background: #2E8555; + color: #fff; + margin-bottom: 20px; +} +.poweredByContainer a { + color: #fff; +} +.poweredByContainer .wrapper h2 { + border-color: #f2c4b2; + color: #f2c4b2; +} +.poweredByContainer .poweredByMessage { + color: #f2c4b2; + font-size: 14px; + padding-top: 20px; +} + +.poweredByItems { + display: flex; + flex-flow: row wrap; + margin: 0 -10px; +} + +.poweredByItem { + box-sizing: border-box; + flex: 1 0 50%; + line-height: 1.1em; + padding: 5px 10px; +} +.poweredByItem.itemLarge { + flex-basis: 100%; + padding: 10px; + text-align: center; +} +.poweredByItem.itemLarge:nth-child(4) { + padding-bottom: 20px; +} +.poweredByItem.itemLarge img { + max-height: 30px; +} + +@media only screen and (min-width: 480px) { + .itemLarge { + flex-basis: 50%; + max-width: 50%; + } +} +@media only screen and (min-width: 1024px) { + .poweredByItem { + flex-basis: 25%; + max-width: 25%; + } + .poweredByItem.itemLarge { + padding-bottom: 20px; + text-align: left; + } +} +.productShowcaseSection { + padding: 0 20px 0; + text-align: center; +} +.productShowcaseSection.paddingTop { + padding-top: 20px; +} +.productShowcaseSection.paddingBottom { + padding-bottom: 80px; +} +.productShowcaseSection h2 { + color: #2E8555; + font-size: 30px; + line-height: 1em; + margin-top: 20px; + text-align: center; + padding: 10px 0; +} +.productShowcaseSection p { + padding: 0.8em 0; + max-width: 560px; + margin: 0 auto; +} +.productShowcaseSection .logos { + padding: 20px; + display: flex; + flex-flow: row wrap; + justify-content: center; + align-items: center; +} +.productShowcaseSection .logos img { + max-height: 110px; + width: 110px; + padding: 20px; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .gridBlock .fourByGridBlock { + box-sizing: border-box; + flex: 1 0 26%; + padding: 10px; + } + .productShowcaseSection .logos img { + max-height: 64px; + width: 64px; + padding: 20px; + } +} + +div.jest-repl { + margin: 0 5%; + position: relative; + width: 600px; +} +div.jest-repl iframe { + display: block; + margin: 0 auto 10px; + min-height: 420px; + width: 100%; +} +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + div.jest-repl { + display: none; + } +} +@media only screen and (min-device-width: 768px) and (max-device-width: 1024px) { + div.jest-repl { + display: none; + } +} +@media only screen and (max-width: 1023px) { + div.jest-repl { + display: none; + } +} + +div.video { + margin: 0 5%; + position: relative; + width: 100%; + min-width: 300px; + max-width: 600px; +} + +div.video iframe { + display: block; + margin: 0 auto 10px; + min-height: 340px; + width: 100%; +} + +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + div.video { + display: none; + } +} +@media only screen and (max-width: 1023px) { + div.video { + display: none; + } +} + +/** Showcase **/ +.showcaseSection { + max-width: 900px; + text-align: center; + margin: 0 auto; +} +.showcaseSection .prose h1 { + color: #2E8555; + font-family: "Helvetica Neue", Arial, sans-serif; + text-align: center; + padding: 1.4em 0 0.4em; +} +.showcaseSection .prose { + max-width: 560px; + text-align: center; + margin: 0 auto; +} +.showcaseSection .logos { + align-items: center; + display: flex; + flex-flow: row wrap; + justify-content: center; +} +.showcaseSection .logos img { + max-height: 128px; + width: 128px; + padding: 20px; +} + +@media only screen and (min-device-width: 360px) and (max-device-width: 736px) { + .showcaseSection .logos img { + max-height: 64px; + width: 64px; + padding: 20px; + } +} + +/** Footer **/ +footer.nav-footer { + position: relative; + box-sizing: border-box; + border: none; + font-weight: 400; + color: #202020; + font-size: 15px; + line-height: 24px; + background: #808080; + box-shadow: inset 0 10px 10px -5px rgba(0,0,0,0.2); + padding-top: 2em; + padding-bottom: 2em; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} +footer .sitemap { + display: flex; + justify-content: space-between; + max-width: 1080px; + margin: 0 auto 3em; +} +footer .sitemap div { + flex: 1; +} +footer .sitemap .nav-home { + display: table; + margin: -12px 20px 0 0; + padding: 10px; + width: 50px; + height: 50px; + opacity: 0.4; + transition: opacity 0.15s ease-in-out; +} +footer .sitemap .nav-home:hover, +footer .sitemap .nav-home:focus { + opacity: 1.0; +} +@media screen and (max-width: 740px) { + footer .sitemap { + display: none; + } +} + +footer .sitemap a { + color: rgba(255, 255, 255, 0.6); + display: table; + margin: 2px -10px; + padding: 3px 10px; +} +footer .sitemap a:hover, +footer .sitemap a:focus { + color: white; + text-decoration: none; +} +footer .sitemap h5 > a:hover, +footer .sitemap h5 > a:focus { + color: white; + text-decoration: none; +} +footer .sitemap h5, +footer .sitemap h6 { + margin: 0 0 10px; +} +footer .sitemap h5 { + color: white; +} + +footer .sitemap h6, +footer .sitemap h5 > a, +footer .sitemap h6 > a { + color: #cca0a7; +} +footer .sitemap h5 > a, +footer .sitemap h6 > a { + margin: 0 -10px; +} +footer .fbOpenSource { + display: block; + margin: 1em auto; + opacity: 0.4; + transition: opacity 0.15s ease-in-out; + width: 170px; +} +footer .fbOpenSource:hover { + opacity: 1.0; +} +footer .copyright { + color: rgba(255, 255, 255, 0.4); + text-align: center; +} diff --git a/docs/api-pages.html b/docs/api-pages.html new file mode 100644 index 0000000000..c21fcd7964 --- /dev/null +++ b/docs/api-pages.html @@ -0,0 +1,35 @@ +Pages and Styles · Docusaurus

Docusaurus

Edit this Doc

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages folder 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". Files in website/pages/en will also get copied out into pages and will OVERRIDE any files of the same name in 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.

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

A React component that parses Markdown to html.

Example:

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

CompLibrary.Container #

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

Padding choices: all, bottom, left, right, top.
Background choices: dark, highlight, light.

Example:

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

CompLibrary.GridBlock #

A React component to organize text and images.

The align attribute determines text alignment. Text alignment defaults to left and can be set to center or right.

The layout attribute determines number of column sections per GridBlock. layout defaults to twoColumn and can be set to threeColumn or fourColumn as well.

The contents attribute is an array containing the contents of each section of the GridBlock. Each content object can have the following fields:

  • content for the text of this section, which is parsed from markdown
  • image for the path to an image to display
  • imageAlign field for image alignment relative to the text, which defaults to top and can be set to bottom, left, or right
  • title for the title to display for this section, which is parsed from markdown
  • imageLink for a link destination from clicking the image

Example:

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

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

Adding Static Pages #

Static .html files can also be used, but they will not include Docusaurus's header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatively, they can be placed in the pages folder and would be served as-is instead of being rendered from React.

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

← PreviousNext →
\ No newline at end of file diff --git a/docs/blog.html b/docs/blog.html new file mode 100644 index 0000000000..944bb0936c --- /dev/null +++ b/docs/blog.html @@ -0,0 +1,33 @@ +Adding a Blog · Docusaurus

Docusaurus

Edit this Doc

Adding a Blog

Initial Setup #

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

Then, add a header link to your blog within siteConfig.js:

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

Adding blog posts #

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.

For example, we will create the following file website/blog/2017-08-18-Introducing-Docusaurus.md:

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

Blog Post Summaries #

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <!--truncate--> will be part of the summary. For example:

---
+title: Truncation Exmaple
+---
+
+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.

Special blog post header options #

The only required field is title; however, we provide options to add author information to your blog post as well.

  • author - The text label of the author byline.
  • 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.
← PreviousNext →
\ No newline at end of file diff --git a/docs/commands.html b/docs/commands.html new file mode 100644 index 0000000000..487cadff40 --- /dev/null +++ b/docs/commands.html @@ -0,0 +1,8 @@ +CLI Commands · Docusaurus

Docusaurus

Edit this Doc

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

Running from the command line #

The scripts can be run using either Yarn or npm. If you've already gone through our Getting Started guide, you may already be familiar with the start command. It's the command that tells Docusaurus to run the docusaurus-start script which generates the site and starts up a server, and it's usually invoked like so:

yarn run start

The same script can be invoked using npm:

npm run start

To run a particular script, just replace the start command in the examples above with the command associated with your script.

Using arguments #

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

If you run Docusaurus using npm, you can still use the command line arguments by inserting a -- between npm run <command> and the command arguments:

npm run start -- --port 8080

Configuration #

These scripts are set up under the "scripts" key in your website/package.json file as part of the installation process. If you need help setting them up again, please refer to the Installation guide.

Docusaurus provides some default mappings to allow you to run commands following Node conventions. Instead of typing docusaurus-start every time, you can type yarn run start or npm start to achieve the same.

Commands #

Reference #

docusaurus-build #

Alias: build.

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

See also docusaurus-start.

docusaurus-examples [feature] #

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

Alias: publish-gh-pages

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

  • GIT_USER: The git user to be associated with the deploy commit.
  • CIRCLE_BRANCH: The git branch associated with the commit that triggered the CI run.
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the git repo, e.g. "FacebookExperimental".
  • CIRCLE_PROJECT_REPONAME: The name of the git repo, e.g. "Docusaurus".
  • CI_PULL_REQUEST: Expected to be truthy if the current CI run was triggered by a commit in a pull request.

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

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

Alias: rename-version

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

See the Versioning guide to learn more.

docusaurus-start [--port <number>] #

Alias: start.

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

docusaurus-version <version> #

Alias: version

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

See the Versioning guide to learn more.

docusaurus-write-translations #

Alias: write-translations

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

← PreviousNext →
\ No newline at end of file diff --git a/docs/custom-pages.html b/docs/custom-pages.html new file mode 100644 index 0000000000..65b649a975 --- /dev/null +++ b/docs/custom-pages.html @@ -0,0 +1,16 @@ +Custom Pages · Docusaurus

Docusaurus

Edit this Doc

Custom Pages

Customizing Your Home Page #

The easiest way to get started customizing your home page is to use the examples generated previously. You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

Adding Other Custom Pages #

Docusaurus provides some simple example pages (index.js, users.js, help.js), but of course you're also free to write your own pages however you want. It is strongly suggested that you at least have an index page, but none of the pages are mandatory to include. More information on how to use the provided components or include your own can be found here. Information on how to link to your different pages in the header navigation bar can be found here.

Customizing Your Site Footer #

Starting from the example core/Footer.js file you generated before, edit the footer to include any links to pages on your site or elsewhere that you wish to have.

The example provided has three columns with a footer image on the left and Facebook's open source logo and copyright at the bottom. If your project is not a Facebook open source project, remove the logo and copyright. Otherwise, feel free to get creative with your footer and make it look however you'd like!

Some suggestions for links you may want to provide: documentation, API, Twitter, Discord, Facebook groups, Stack Overflow, GitHub, etc.

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

If you don't 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;
← PreviousNext →
\ No newline at end of file diff --git a/docs/doc-markdown.html b/docs/doc-markdown.html new file mode 100644 index 0000000000..d15718e5b3 --- /dev/null +++ b/docs/doc-markdown.html @@ -0,0 +1,30 @@ +Markdown Features · Docusaurus

Docusaurus

Edit this Doc

Markdown Features

Markdown Headers #

Documents #

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

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

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

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 it's title.

For example:

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

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

For example:

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

Blog Posts #

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

title: The title of this blog post.

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: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post.

For example:

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

Extra Features #

Docusaurus supports some extra features when writing documentation in markdown.

Linking other Documents #

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

Example:

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

This markdown will automatically get converted into a link to /docs/other-document.html (or the appropriately translated/versioned link) once it gets rendered.

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.

Linking to Images and Other Assets #

Static assets can be linked to in the same way that documents are, using relative urls. Static assets used in documents and blogs should go into docs/assets and website/blog/assets, respectively. The markdown will get converted into correct link paths so that these paths will work for documents of all languages and versions.

Example:

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

Generating Table of Contents #

You can make an autogenerated 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>. Write your documentation using h3 headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

Example:

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

will lead to a table of contents of the functions:

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

and each function will link to their corresponding sections in the page.

← Previous
\ No newline at end of file diff --git a/docs/getting-started.html b/docs/getting-started.html new file mode 100644 index 0000000000..7b8fd4f287 --- /dev/null +++ b/docs/getting-started.html @@ -0,0 +1,54 @@ +getting-started · Docusaurus

Docusaurus

Edit this Doc

getting-started

Getting Started #

Project Structure #

In your project repo, all of your documentation files should be placed inside a docs folder. Any blog posts should be inside a blog folder. Create a website folder inside which you will install and run docusaurus.

Example project structure:

project-repo/
+  blog/
+    2017-05-06-blog-post.md
+  docs/
+    en/
+      doc1.md
+  website/

Installation #

Inside of your website folder, create a package.json file with the following scripts for Docusaurus:

{
+  "scripts": {
+    "start": "docusaurus-start",
+    "build": "docusaurus-build",
+    "publish-gh-pages": "docusaurus-publish",
+    "examples": "docusaurus-examples"
+  }
+}

Install Docusaurus using npm or yarn:

npm install --save-dev docusaurus

or

yarn add docusaurus -dev

Configuration #

Generate Examples #

To create example files for configuration, run examples using npm or yarn:

npm run examples

or

yarn run examples

This will create the following files/folders in your website folder:

core/Footer.js
+pages/...
+static/img/...
+siteConfig.js

It will also create two folders in the level above the website folder in your project repo:

blog-examples-from-docusaurus
+docs-examples-from-docusaurus

If any of the files created by yarn run examples already exists, Docusaurus will not overwrite them.

The provided example files contain configurations for an example site.

The 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.
The blog-examples-from-docusaurus folder contains examples of blog posts written in markdown.
The docs-examples-from-docusaurus folder contains example documentation files written in markdown.
The pages folder contains example top-level pages for the site.
The static folder contains static assets used by the example site.
The siteConfig.js file is the main configuration file used by Docusaurus.

You will need to keep the siteConfig.js and core/Footer.js files, but may edit them as you wish.

You should keep the pages and static folders, 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 pages and an image to use as your header icon inside static.

The blog-examples-from-docusaurus and docs-examples-from-docusaurus folders contain example blog and document markdown files. If you wish to run Docusaurus with these files, you need to rename the folders to blog and docs, respectively.

How to Configure Your Site #

Configure the siteConfig.js file which has comments guiding you through what needs to be done and how each configuration affects your website. You can also refer here for more details.

Customize core/Footer.js which will serve as the footer for each page on your website.

Include your own top-level pages as React components in pages:

  • These components should just be the body sections of the pages you want, and they will be included with the header and footer that the rest of Docusaurus uses.
  • Currently, if you want to add other React components to your pages, you must include all of it inside each .js file in pages due to how require paths are set-up.
  • You may also include .html files directly, but this is not recommended, and these will just be served as is and will not have any of the header/footer/styles shared by the rest of Docusaurus.
  • Any files in pages/en will also be copied into pages when the server is run and when the site is statically built. i.e. Putting a file in pages/en/index.js will make it available at /en/index.html and /index.html.

All images and other static assets you wish to include should be placed inside the static folder. Any .css files provided in static will be concatenated to the standard styles provided by Docusaurus and used site-wide.

A React component placed in website/pages/en/index.js will be available at the url /en/index.html. A static html page placed in website/pages/en/index.html will be available at the url /en/index.html. Provided html files will override provided React components.

A static asset placed in website/static/img/image.png will be available at the url /img/image.png.

Example:

localhost:3000${baseUrl}en/index.html
+localhost:3000${baseUrl}img/image.png
+${url}${baseUrl}en/index.html
+${url}${baseUrl}img/image.png

Document and Blog Front Matters #

Documentation should contain front matter that follows this example:

---
+id: doc1 <!-- used for docs to find each other and to map links -->
+title: Document Title
+layout: docs1 <!-- used to determine different sidebar groupings -->
+category: Sidebar Category 1 <!-- category on the sidebar under which this doc goes -->
+permalink: docs/en/doc1.html <!-- link to the document that is used for site -->
+previous: doc0 <!-- previous doc on sidebar for navigation -->
+next: doc2 <!-- next doc on the sidebar for navigation -->
+<!-- don't include next if this is the last doc; don't include previous if first doc -->
+---

Blog posts should be written as markdown files with the following front matter:

---
+title: Blog Post Title
+author: Author Name
+authorURL: http://twitter.com/author <!-- (or some other link) -->
+authorFBID: 21315325 <!-- id to get author's picture -->
+---

In the blog post you should include a line <!--truncate-->. This will determine under which point text will be ignored when generating the preview of your blog post. Blog posts should have the file name format: yyyy-mm-dd-your-file-name.md.

Using Docusaurus #

Run the Server #

To run your website locally run the script:

npm run start

or

yarn run start

This will start a server hosting your website locally at localhost:3000. Any changes to configured files will be reflected by refreshing the page, i.e. the server does not need to be restarted to show changes. You may also specify a different port to start your server on by using a --port flag:

npm run start -- --port 9000

Build Static Pages #

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

npm run build

or

yarn run build

This will generate .html files from all of your docs and other pages included in pages. This allows you to check whether or not all your files are being generated correctly. The build folder is inside Docusaurus's directory inside node_modules.

Publishing Your Website #

Use CircleCI to publish your website whenever your project repo is updated. Configure your circle.yml file in your project repo to run commands to publish to GitHub Pages. An example is shown here:

machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+test:
+  override:
+    - "true"
+
+deployment:
+  website:
+    branch: master
+    commands:
+      - 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
+      - cd website && npm install && GIT_USER=test-site-bot npm run publish-gh-pages

Note that in this case a GitHub user test-site-bot is created to use just for publishing. Make sure to give your Git user push permissions for your project and to set a GITHUB_TOKEN environment variable in Circle if you choose to publish this way.

If you wish to manually publish your website with the publish-gh-pages script, run the following example command with the appropriate variables for your project:

DEPLOY_USER=deltice GIT_USER=test-site-bot CIRCLE_PROJECT_USERNAME=deltice CIRCLE_PROJECT_REPONAME=test-site CIRCLE_BRANCH=master npm run publish-gh-pages

More Information #

For details on how to set up translation support, read here. +For details on how to set up documentation search, read here.

\ No newline at end of file diff --git a/docs/installation.html b/docs/installation.html new file mode 100644 index 0000000000..df6ad9796e --- /dev/null +++ b/docs/installation.html @@ -0,0 +1,15 @@ +Installation · Docusaurus

Docusaurus

Edit this Doc

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, follow these steps:

  1. Create a website folder in the root of your GitHub repo.
  2. cd website

  3. Create a package.json file with the following scripts that will be used when developing documentation with Docusaurus:

     {
+   "scripts": {
+     "start": "docusaurus-start",
+     "build": "docusaurus-build",
+     "publish-gh-pages": "docusaurus-publish",
+     "examples": "docusaurus-examples"
+   }
+ }

  4. Install Docusaurus with yarn or npm

     yarn add docusaurus -dev

    or

     npm install --save-dev docusaurus
Next →
\ No newline at end of file diff --git a/docs/navigation.html b/docs/navigation.html new file mode 100644 index 0000000000..129ae44bdd --- /dev/null +++ b/docs/navigation.html @@ -0,0 +1,48 @@ +Navigation and Sidebars · Docusaurus

Docusaurus

Edit this Doc

Navigation and Sidebars

New Hidden Docs #

New markdown files within docs will show up as pages on the website. Creating a file such as "docs/getting-started.md" will enable the new page /docs/getting-started.html.

To change the id (link name) of the file, set the id field in the markdown header. At the top of getting-started.md:

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

Now, the doc can be accessed from /docs/intro.html.

Adding Docs to a Sidebar #

Now we want our new page to show up on the sidebar. We configure the order of the sidebar in website/sidebars.json.

Within sidebars.json, add the doc ID within an existing sidebar/category:

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

Or you can create a new category within the sidebar:

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

New Hidden Sections #

You can also put the doc in a new sidebar. In this case we are creating a intro section within sidebars.json.

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

Keep in mind, until you add the section to the nav bar (below), this new "intro" section of the site will be hidden with no links going to it.

Adding doc to site nav bar #

After creating a new section of the site by adding to sidebars.json, you can link to the new doc from the top navigation bar by editing the headerLinks field of siteConfig.js.

headerLinks: [
+  ...
+  { doc: 'intro', label: 'Getting Started' },
+  ...
+],

Custom page links in nav bar #

To add custom pages to the navigation bar, entries can be added to the headerLinks of siteConfig.js. For example, if we have a page within website/pages/help.js, we can link to it by adding the following:

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

External links in nav bar #

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

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

To open external links in a new tab, provide an external: true flag within the header link config.

Search bar position in nav bar #

If search is enabled on your site, your search bar will appear to the right of your links. If you want to put the search bar between links in the header, add a search entry in the headerLinks config array:

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

Languages dropdown position in nav bar #

If translations is enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). If you want to put the language selection drop down between links in the header, add a languages entry in the headerLinks config array:

headerLinks: [
+  { doc: 'foo', label: 'Foo' },
+  { languages: true },
+  { doc: 'bar', label: 'Bar' },
+],
← PreviousNext →
\ No newline at end of file diff --git a/docs/search.html b/docs/search.html new file mode 100644 index 0000000000..5aae1b9496 --- /dev/null +++ b/docs/search.html @@ -0,0 +1,31 @@ +Enabling Search · Docusaurus

Docusaurus

Edit this Doc

Enabling Search

Docusaurus supports search using 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.

Enabling the Search Bar #

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. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

const siteConfig = {
+  ...
+  algolia: {
+    ...
+    algoliaOptions: '{ facetFilters: [ "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.

← PreviousNext →
\ No newline at end of file diff --git a/docs/site-config.html b/docs/site-config.html new file mode 100644 index 0000000000..12a80853f9 --- /dev/null +++ b/docs/site-config.html @@ -0,0 +1,71 @@ +siteConfig.js · Docusaurus

Docusaurus

Edit this Doc

siteConfig.js

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

User Showcase #

The users array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someon. The pinned field determines whether or not it shows up on the index page.

Currently this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

siteConfig Fields #

The siteConfig object contains the bulk of the configuration settings for your website.

Mandatory Fields #

title - Title for your website.

tagline - Tagline for your website.

url - url for your site.

baseUrl - baseUrl for your site.

projectName - Project name.

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.

Example Usage:

headerLinks: [
+  // Links to document with id doc1 for current language/version
+  { doc: "doc1", label: "Getting Started" }, 
+  // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
+  { page: "help", label: "Help" },
+  // Links to href destination
+  { 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 }
+],

headerIcon - url for icon used in header navigation bar.

favicon - url for site favicon.

colors - Color configurations for the site.

  • primaryColor is the color used the header navigation bar and sidebars.
  • secondaryColor is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile).
  • prismColor is the color used in the background of syntax highlighting for code in documentation. It is recommended to be the same color as primaryColor in rgba form with an alpha value of 0.03. Other fields can be added
  • Custom color configurations can also be added. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to easily configure this color.

Optional Fields #

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.

users - The users array mentioned earlier.

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.

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

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.

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

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header.

gaTrackingId - Google Analytics tracking ID to track page views.

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://deltice.github.io",
+// url: "https://www.example.com",
+  baseUrl: "/test-site/",
+// baseUrl: "/",
+  projectName: "docusaurus",
+  headerLinks: [
+    { doc: "doc1", label: "Docs" },
+    { page: "help", label: "Help" },
+    { search: true },
+    { blog: true }
+  ],
+// headerLinks: [],
+  headerIcon: "img/docusaurus.svg",
+  favicon: "img/favicon.png",
+  colors: {
+    primaryColor: "#2E8555",
+    secondaryColor: "#205C3B",
+    prismColor:
+      "rgba(46, 133, 85, 0.03)"
+  },
+
+
+  editUrl: "https://github.com/deltice/test-site/edit/master/docs/",
+  users,
+  disableHeaderTitle: true,
+  disableTitleTagline: true,
+  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
+  footerIcon: "img/docusaurus.svg",
+  recruitingLink:
+    "https://crowdin.com/project/docusaurus",
+  algolia: {
+    apiKey:
+      "0f9f28b9ab9efae89810921a351753b5",
+    indexName: "github"
+  }
+  gaTrackingId: "U-A2352"
+};
+
+module.exports = siteConfig;
← PreviousNext →
\ No newline at end of file diff --git a/docs/site-creation.html b/docs/site-creation.html new file mode 100644 index 0000000000..62f70e0514 --- /dev/null +++ b/docs/site-creation.html @@ -0,0 +1,15 @@ +Creating your site · Docusaurus

Docusaurus

Edit this Doc

Creating your site

Docusaurus' primary purpose of existence is to make it super simple for you to create documentation for your project and have a site to house those docs.

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

Load the Example Site #

Preparation created a sample site for you to see Docusaurus in action. However, it also provided the infrastructure that will be used as you are developing your own site.

Site Structure #

After loading the example site, you should see a structure in your repo that looks similar to:

project-repo/
+  docs/
+    doc1.md
+  website/
+    blog/
+      2017-05-06-blog-post.md

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

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.

  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. Modify the website/siteConfig.js file to configure your site, following the comments included in that file to guide you.

  4. Customize the website/core/Footer.js file that provides the footer for your site.
  5. Place assets, such as images, in the website/static/ folder.

  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
← PreviousNext →
\ No newline at end of file diff --git a/docs/site-preparation.html b/docs/site-preparation.html new file mode 100644 index 0000000000..4501193507 --- /dev/null +++ b/docs/site-preparation.html @@ -0,0 +1,13 @@ +Site Preparation · Docusaurus

Docusaurus

Edit this Doc

Site Preparation

After installing Docusaurus, you will want to install and run the example site included. This serves dual purposes.

  1. Verifying that Docusaurus was installed correctly.
  2. Providing you the skeleton to create your site.

Verifying Installation #

  1. Generate the files for the example site by running examples using yarn or npm.

     npm run examples

    or

     yarn run examples

    If any of the files created by [yarn | npm] run examples already exists, Docusaurus will not overwrite them.

  2. Run the server.

     npm run start

    or

     yarn run start

  3. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.

Example Site Configuration #

Loading the example site will create the following files/folders:

website/core/Footer.js
+website/pages/...
+website/static/img/...
+website/siteConfig.js
+website/blog-examples-from-docusaurus/...
+docs-examples-from-docusaurus/...

The docs-examples-from-docusaurus folder will be at the same directory level as website, not in it.

The provided example files contain configurations that can be used as starting points for your site:

  • 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.
  • The website/blog-examples-from-docusaurus folder contains examples of blog posts written in markdown.
  • The docs-examples-from-docusaurus folder contains example documentation files written in markdown.
  • The website/pages folder contains example top-level pages for the site.
  • The website/static folder contains static assets used by the example site.
  • The website/siteConfig.js file is the main configuration file used by Docusaurus.

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

The website/blog-examples-from-docusaurus and docs-examples-from-docusaurus folders contain example blog and document markdown files. If you wish to run Docusaurus with these files, you need to rename the folders to website/blog and docs, respectively.

← PreviousNext →
\ No newline at end of file diff --git a/docs/translation.html b/docs/translation.html new file mode 100644 index 0000000000..0f3fea706e --- /dev/null +++ b/docs/translation.html @@ -0,0 +1,55 @@ +Translations · Docusaurus

Docusaurus

Edit this Doc

Translations

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations #

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

npm run examples translations

This will create the following files:

pages/en/help-with-translations.js
+languages.js
+crowdin.yaml

The pages/en/help-with-translations.js file is the same example help page generated by the examples script but now using translations tags that are described below. +The languages.js file tells Docusaurus what languages you want to enable for your site. +The crowdin.yaml file is used to configure crowdin integration, and is copied out one level into your project repo.

Writing Pages to be Translated #

Any pages with text you want to be translated should go into the website/pages/en folder. Simply wrap any strings you want translated in a <translate> tag, and add the following require statement to the top of the file:

...
+const translate = require("../../server/translate.js").translate;
+...
+<h2>
+  <translate>This is a Header I want translated</translate>
+</h2>
+...

You can also include an optional description attribute to give more context to a translator about how to translate the string:

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

Documentation files do not need to be changed to support translations. They will be uploaded to Crowdin to be translated directly.

Gathering Strings to Translate #

Add the following script to your package.json file:

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

Running the script will generate a website/i18n/en.json file containing all the strings that will be translated from English into other languages.

The script will include text from the following places:

  • title and sidebar_label strings in document markdown headers
  • category names in sidebars.json
  • tagline in siteConfig.js
  • header link label strings in siteConfig.js
  • strings wrapped in the <translate> tag in any .js files inside pages

How Strings Get Translated #

Docusaurus itself does not do any translation from one language to another. Instead, it uses Crowdin to manage translations and then downloads appropriately translated files from Crowdin. More information on how to set up Crowdin translations later.

How Docusaurus Uses String Translations #

This section provides some more context for how translation works, but is not necessary information for the user to know.

For things like the strings found in the headers and sidebars of pages, Docusaurus references a translated version of i18n/en.json (for example, a i18n/fr.json file downloaded from Crowdin).

For documentation text itself, fully translated markdown files will be compiled in the same way English documentation markdown files would be.

For other pages, Docusaurus will automatically transform all <translate> tags into function calls that will return appropriately translated strings. For each language that is enabled with languages.js, Docusaurus will build translated pages using the files in pages/en and the language's respective .json file in i18n.

Crowdin Set-Up #

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow.

To automatically get the translations for your files, 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.

Translations and Versioning #

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

← PreviousNext →
\ No newline at end of file diff --git a/docs/versioning.html b/docs/versioning.html new file mode 100644 index 0000000000..b9c4e7bdb0 --- /dev/null +++ b/docs/versioning.html @@ -0,0 +1,16 @@ +Versioning · Docusaurus

Docusaurus

Edit this Doc

Versioning

Users can use the version script to cut a new documentation version based on the latest content in the docs folder. That specific set of documentation will then be preserved and accessible even as the documentation in the docs folder changes moving forward.

How to Create New Versions #

Add the following script to your package.json file:

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

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

npm 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, and the site will display the version number next to the title in the header.

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 npm 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 #

Users can create version numbers in whatever format they 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 appending "version-${version}-" to the id and by adding an original_id field.

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebar.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.,

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

← PreviousNext →
\ No newline at end of file diff --git a/en/help.html b/en/help.html new file mode 100644 index 0000000000..f3f798558b --- /dev/null +++ b/en/help.html @@ -0,0 +1,2 @@ +Docusaurus · Open Source Documentation Websites

Docusaurus

Need help?

This project is maintained by a dedicated group of people.

Browse Docs

Learn more using the documentation on this site.

Join the community

Submit issues and pull requests for any new features you may want to see or bugs you've found on GitHub.

Stay up to date

Find out what's new with this project by checking back on the site.

\ No newline at end of file diff --git a/en/index.html b/en/index.html new file mode 100644 index 0000000000..4f266b9c11 --- /dev/null +++ b/en/index.html @@ -0,0 +1,4 @@ +Docusaurus · Open Source Documentation Websites

Docusaurus

DocusaurusOpen Source Documentation Websites

Get Started

Powered by Markdown

Save time and focus on your project's documentation. Simply write docs and blog posts with Markdown and Docusaurus will publish a set of static html files ready to serve.

Built Using React

Extend or customize your project's layout by reusing React. Docusaurus can be extended while reusing the same header and footer.

Ready for Translations

Localization comes pre-configured. Use Crowdin to translate your docs into over 70 languages.



Document Versioning

Support users on all versions of your project. Document Versioning helps you keep documentation in sync with project releases.

Document Search

Make it easy for your community to find what they need in your documentation. Currently supports Algolia DocSearch.

Quick Setup

Get up and running quickly without having having to worry about site design.

Develop and Deploy

Make design and documentation changes by using the included live server. Publish your site to GitHub pages or other static file hosts manually, using a script, or with continuous integration like CircleCI.

Website Features

Docusaurus currently provides support to help your website use translations, search, and versioning, along with some other special documentation markdown features. If you have ideas for useful features, feel free to contribute on GitHub!

Who's Using This?

Docusaurus is building websites for these projects

All Docusaurus Users
\ No newline at end of file diff --git a/en/users.html b/en/users.html new file mode 100644 index 0000000000..5be3d658f2 --- /dev/null +++ b/en/users.html @@ -0,0 +1,2 @@ +Docusaurus · Open Source Documentation Websites

Docusaurus

Who's Using This?

This project is used by many folks

Are you using this project?

Add your project
\ No newline at end of file diff --git a/help.html b/help.html new file mode 100644 index 0000000000..f3f798558b --- /dev/null +++ b/help.html @@ -0,0 +1,2 @@ +Docusaurus · Open Source Documentation Websites

Docusaurus

Need help?

This project is maintained by a dedicated group of people.

Browse Docs

Learn more using the documentation on this site.

Join the community

Submit issues and pull requests for any new features you may want to see or bugs you've found on GitHub.

Stay up to date

Find out what's new with this project by checking back on the site.

\ No newline at end of file diff --git a/img/docusaurus.svg b/img/docusaurus.svg new file mode 100644 index 0000000000..81b7405edd --- /dev/null +++ b/img/docusaurus.svg @@ -0,0 +1,35 @@ + + + + docusaurus + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/img/docusaurus_keytar.svg b/img/docusaurus_keytar.svg new file mode 100644 index 0000000000..b4d2e15c37 --- /dev/null +++ b/img/docusaurus_keytar.svg @@ -0,0 +1,155 @@ + + + + docusaurus_keytar + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/img/docusaurus_live.gif b/img/docusaurus_live.gif new file mode 100644 index 0000000000..5eed99bad8 Binary files /dev/null and b/img/docusaurus_live.gif differ diff --git a/img/docusaurus_live.webp b/img/docusaurus_live.webp new file mode 100644 index 0000000000..009747c957 Binary files /dev/null and b/img/docusaurus_live.webp differ diff --git a/img/docusaurus_monochrome.svg b/img/docusaurus_monochrome.svg new file mode 100644 index 0000000000..53806d0c74 --- /dev/null +++ b/img/docusaurus_monochrome.svg @@ -0,0 +1,35 @@ + + + + docusaurus_monochrome + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/img/docusaurus_speed.svg b/img/docusaurus_speed.svg new file mode 100644 index 0000000000..fd1170427c --- /dev/null +++ b/img/docusaurus_speed.svg @@ -0,0 +1,61 @@ + + + + docusaurus_speed + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/img/fasttext.png b/img/fasttext.png new file mode 100644 index 0000000000..14daa73667 Binary files /dev/null and b/img/fasttext.png differ diff --git a/img/favicon.png b/img/favicon.png new file mode 100644 index 0000000000..122f0a56c5 Binary files /dev/null and b/img/favicon.png differ diff --git a/img/favicon/favicon.ico b/img/favicon/favicon.ico new file mode 100644 index 0000000000..eaced0fd8e Binary files /dev/null and b/img/favicon/favicon.ico differ diff --git a/img/frank.svg b/img/frank.svg new file mode 100644 index 0000000000..f80b2217c7 --- /dev/null +++ b/img/frank.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/img/language.svg b/img/language.svg new file mode 100644 index 0000000000..66195932ab --- /dev/null +++ b/img/language.svg @@ -0,0 +1,3 @@ + + + diff --git a/img/markdown.png b/img/markdown.png new file mode 100644 index 0000000000..ebe191814a Binary files /dev/null and b/img/markdown.png differ diff --git a/img/oss_logo.png b/img/oss_logo.png new file mode 100644 index 0000000000..8183e289b1 Binary files /dev/null and b/img/oss_logo.png differ diff --git a/img/prettier.png b/img/prettier.png new file mode 100644 index 0000000000..47a2f82eb2 Binary files /dev/null and b/img/prettier.png differ diff --git a/img/react.svg b/img/react.svg new file mode 100644 index 0000000000..d338d72f1f --- /dev/null +++ b/img/react.svg @@ -0,0 +1,21 @@ + + + + + + + + + diff --git a/img/search.svg b/img/search.svg new file mode 100644 index 0000000000..2ac4eacf58 --- /dev/null +++ b/img/search.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/img/translation.svg b/img/translation.svg new file mode 100644 index 0000000000..9588283380 --- /dev/null +++ b/img/translation.svg @@ -0,0 +1,3 @@ + + + diff --git a/img/versioning.svg b/img/versioning.svg new file mode 100644 index 0000000000..816e9fa9d0 --- /dev/null +++ b/img/versioning.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/index.html b/index.html new file mode 100644 index 0000000000..4f266b9c11 --- /dev/null +++ b/index.html @@ -0,0 +1,4 @@ +Docusaurus · Open Source Documentation Websites

Docusaurus

DocusaurusOpen Source Documentation Websites

Get Started

Powered by Markdown

Save time and focus on your project's documentation. Simply write docs and blog posts with Markdown and Docusaurus will publish a set of static html files ready to serve.

Built Using React

Extend or customize your project's layout by reusing React. Docusaurus can be extended while reusing the same header and footer.

Ready for Translations

Localization comes pre-configured. Use Crowdin to translate your docs into over 70 languages.



Document Versioning

Support users on all versions of your project. Document Versioning helps you keep documentation in sync with project releases.

Document Search

Make it easy for your community to find what they need in your documentation. Currently supports Algolia DocSearch.

Quick Setup

Get up and running quickly without having having to worry about site design.

Develop and Deploy

Make design and documentation changes by using the included live server. Publish your site to GitHub pages or other static file hosts manually, using a script, or with continuous integration like CircleCI.

Website Features

Docusaurus currently provides support to help your website use translations, search, and versioning, along with some other special documentation markdown features. If you have ideas for useful features, feel free to contribute on GitHub!

Who's Using This?

Docusaurus is building websites for these projects

All Docusaurus Users
\ No newline at end of file diff --git a/users.html b/users.html new file mode 100644 index 0000000000..5be3d658f2 --- /dev/null +++ b/users.html @@ -0,0 +1,2 @@ +Docusaurus · Open Source Documentation Websites

Docusaurus

Who's Using This?

This project is used by many folks

Are you using this project?

Add your project
\ No newline at end of file