From 9b35317fb5e54a945aded8600cde212a632eb9e2 Mon Sep 17 00:00:00 2001 From: Frank Li Date: Thu, 27 Jul 2017 16:15:47 -0700 Subject: [PATCH 1/3] Initial website set-up for Docusaurus --- website/core/Footer.js | 90 +++++++++++ website/package.json | 9 ++ website/pages/en/help.js | 56 +++++++ website/pages/en/index.js | 214 +++++++++++++++++++++++++ website/pages/en/users.js | 56 +++++++ website/siteConfig.js | 55 +++++++ website/static/img/docusaurus.svg | 1 + website/static/img/favicon.png | Bin 0 -> 984 bytes website/static/img/favicon/favicon.ico | Bin 0 -> 9662 bytes website/static/img/markdown.png | Bin 0 -> 7074 bytes website/static/img/oss_logo.png | Bin 0 -> 4370 bytes website/static/img/prettier.png | Bin 0 -> 4581 bytes website/static/img/react.svg | 21 +++ website/static/img/translation.svg | 3 + 14 files changed, 505 insertions(+) create mode 100644 website/core/Footer.js create mode 100644 website/package.json create mode 100755 website/pages/en/help.js create mode 100755 website/pages/en/index.js create mode 100644 website/pages/en/users.js create mode 100644 website/siteConfig.js create mode 100644 website/static/img/docusaurus.svg create mode 100644 website/static/img/favicon.png create mode 100644 website/static/img/favicon/favicon.ico create mode 100644 website/static/img/markdown.png create mode 100644 website/static/img/oss_logo.png create mode 100644 website/static/img/prettier.png create mode 100644 website/static/img/react.svg create mode 100644 website/static/img/translation.svg diff --git a/website/core/Footer.js b/website/core/Footer.js new file mode 100644 index 0000000000..38dd067bc4 --- /dev/null +++ b/website/core/Footer.js @@ -0,0 +1,90 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the BSD-style license found in the + * LICENSE file in the root directory of this source tree. An additional grant + * of patent rights can be found in the PATENTS file in the same directory. + */ + +const React = require("react"); + +const githubButton = ( + + Star + +); + +class Footer extends React.Component { + render() { + const currentYear = new Date().getFullYear(); + return ( + + ); + } +} + +module.exports = Footer; diff --git a/website/package.json b/website/package.json new file mode 100644 index 0000000000..86441d4fbb --- /dev/null +++ b/website/package.json @@ -0,0 +1,9 @@ +{ + "scripts": { + "start": "chmod +x ../lib/start-server.js && ../lib/start-server.js", + "build": "chmod +x ../lib/build-files.js && ../lib/build-files.js", + "publish-gh-pages": "chmod +x ../lib/publish-gh-pages.js && ../lib/publish-gh-pages.js", + "examples": "chmod +x ../lib/copy-examples.js && ../lib/copy-examples.js", + "write-translations": "chmod +x ../lib/write-translations.js && ../lib/write-translations.js" + } +} diff --git a/website/pages/en/help.js b/website/pages/en/help.js new file mode 100755 index 0000000000..8bce351835 --- /dev/null +++ b/website/pages/en/help.js @@ -0,0 +1,56 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the BSD-style license found in the + * LICENSE file in the root directory of this source tree. An additional grant + * of patent rights can be found in the PATENTS file in the same directory. + */ + +const React = require("react"); + +const CompLibrary = require("../../core/CompLibrary.js"); +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +const siteConfig = require(process.cwd() + "/siteConfig.js"); + +class Help extends React.Component { + render() { + const supportLinks = [ + { + content: + "Learn more using the [documentation on this site](/docusaurus/docs/en/getting-started.html).", + title: "Browse Docs" + }, + { + content: "Submit issues and pull requests for any new features you may want to see or bugs you've found on [GitHub](https://github.com/facebookexperimental/docusaurus).", + title: "Join the community" + }, + { + content: "Find out what's new with this project by checking back on the site.", + title: "Stay up to date" + } + ]; + + return ( +
+ +
+
+

Need help?

+
+

This project is maintained by a dedicated group of people.

+ +
+
+
+ ); + } +} + +Help.defaultProps = { + language: "en" +}; + +module.exports = Help; diff --git a/website/pages/en/index.js b/website/pages/en/index.js new file mode 100755 index 0000000000..1ed2fc74bd --- /dev/null +++ b/website/pages/en/index.js @@ -0,0 +1,214 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the BSD-style license found in the + * LICENSE file in the root directory of this source tree. An additional grant + * of patent rights can be found in the PATENTS file in the same directory. + */ + +const React = require("react"); + +const CompLibrary = require("../../core/CompLibrary.js"); +const Marked = CompLibrary.Marked; /* Used to read markdown */ +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +const siteConfig = require(process.cwd() + "/siteConfig.js"); + +class Button extends React.Component { + render() { + return ( +
+ + {this.props.children} + +
+ ); + } +} + +Button.defaultProps = { + target: "_self" +}; + +class HomeSplash extends React.Component { + render() { + return ( +
+
+
+
+ +
+
+

+ {siteConfig.title} + + {siteConfig.tagline} + +

+
+
+
+ +
+
+
+
+
+
+
+ ); + } +} + +class Index extends React.Component { + render() { + let language = this.props.language || "en"; + const showcase = siteConfig.users + .filter(user => { + return user.pinned; + }) + .map(user => { + return ( + + + + ); + }); + + return ( +
+ +
+ + +
+
+ +
+ + + + + + + + + + +
+

+ {"Who's Using This?"} +

+

Docusaurus is building websites for these projects

+
+ {showcase} +
+ +
+
+
+ ); + } +} + +module.exports = Index; diff --git a/website/pages/en/users.js b/website/pages/en/users.js new file mode 100644 index 0000000000..e5d9f16b42 --- /dev/null +++ b/website/pages/en/users.js @@ -0,0 +1,56 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the BSD-style license found in the + * LICENSE file in the root directory of this source tree. An additional grant + * of patent rights can be found in the PATENTS file in the same directory. + */ + +const React = require("react"); + +const CompLibrary = require("../../core/CompLibrary.js"); +const Container = CompLibrary.Container; + +const siteConfig = require(process.cwd() + "/siteConfig.js"); + +class Users extends React.Component { + render() { + const showcase = siteConfig.users.map(user => { + return ( + + + + ); + }); + + return ( +
+ +
+
+

Who's Using This?

+

This project is used by many folks

+
+
+ {showcase} +
+

Are you using this project?

+ + Add your company + +
+
+
+ ); + } +} + +Users.defaultProps = { + language: "en" +}; + +module.exports = Users; diff --git a/website/siteConfig.js b/website/siteConfig.js new file mode 100644 index 0000000000..537bd95ba1 --- /dev/null +++ b/website/siteConfig.js @@ -0,0 +1,55 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the BSD-style license found in the + * LICENSE file in the root directory of this source tree. An additional grant + * of patent rights can be found in the PATENTS file in the same directory. + */ + +/* List of projects/orgs using your project for the users page */ +const users = [ + { + caption: "Prettier", + image: "/docusaurus/img/prettier.png", + infoLink: "https://www.prettier.io", + pinned: true + } +]; + +const siteConfig = { + title: "Docusaurus", + tagline: "Open Source Documentation Websites", + url: "https://facebookexperimental.github.io", + baseUrl: "/docusaurus/", + projectName: "docusaurus", + users, + editUrl: + "https://github.com/facebookexperimental/docusaurus/edit/master/docs/", + headerLinksInternal: [ + { + section: "docs", + href: "/docusaurus/docs/LANGUAGE/getting-started.html", + text: "Docs" + }, + { section: "help", href: "/docusaurus/LANGUAGE/help.html", text: "Help" } + ], + headerLinksExternal: [ + { + section: "github", + href: "https://github.com/facebookexperimental/docusaurus", + text: "GitHub" + } + ], + headerIcon: "img/docusaurus.svg", + footerIcon: "img/docusaurus.svg", + favicon: "img/favicon.png", + colors: { + primaryColor: "#2E8555", + secondaryColor: "#205C3B", + prismColor: + "rgba(46, 133, 85, 0.03)" + } +}; + +module.exports = siteConfig; diff --git a/website/static/img/docusaurus.svg b/website/static/img/docusaurus.svg new file mode 100644 index 0000000000..f80b2217c7 --- /dev/null +++ b/website/static/img/docusaurus.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/static/img/favicon.png b/website/static/img/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..122f0a56c5bbaf730e8bd9357a9df215ac7c55d8 GIT binary patch literal 984 zcmV;}11J26P) zK~z}7?UqYy8&wpBzj=7ZuP`2CJIIU&xAlQP~ z1DgU83#2Y9!~!-5RV;`gC9OyzO4HCdZfPvi*tH!eu^Y#6JRT1lvuP8liM>JczdZMx zqhI%a=iUn~{ZDilhzqiC1AztLYha`qjipD((M4JODe`V4v43>`(avaR#ntWFC@vP? zGRtNdNCD}+8W0{K=Th(4-kLtBk3JAD7Gi~~x4*d^0>VITF9yUN;x6Dl;G(DBqv?bC z3)|$lwTSkTr{9wWj_!2__mu3EgIH_=IYAKY+ZmP}axOiQjspJx^NsF6PaQhr`lr{Is>P}o2m%a$I6NUc z)rq^0b7kQPykXlzq&bEEmk$)GVm*KA8Q9-CG1L@l2mmy0-S3U!U8aW z#c?21hw-Fjmkik{hj-{vG^?g;lnfVetr=5L1SWwMU=f%z%cgVYvzg^ezVZ-gxv5;r z+%(%Q({cjOHDd|@x`B@YACLfKPsDRi@hH*yy7?c#fg^#@(!J7U#jC8Q#!~KP891$I z$}!&|-@K};Mk!mGFWoKqfKvQIeA=v-(!iSoZpkJM19Y6|sLp;dd#XOJeqg!Lt9Z%W zG9&AW^@V&ae|qEY##4Q-_bn9W3V-M4^Zh-q^ej1ijuAiskQ|bly_(&0b-6Yxg~}oj zZ`8m#@H5~NW%0G4_lN#;_#G!4K}V(iNPD@QE3exgvmr`i06-9gHa((GCdZP8u}A?| zfNCReK_?=U+5v4LbT(v{?Q*!bRl8%9jQf^h8FrsNj7ax`MYT$8Ht|DZWo>4y1GoT; z1F<^TyE5=e@0s2w^&$P`#CM7D)xTClmTAR-c3@airOe1jBQ^xQ+ZET0S}Zx1yp_3< zc@_8^_+YmN&TD~He zpm;#>fZ~Bg_W%P0pMW6v0PF{Afd>2+EFB_6u9OQIt;R03UfoC6;Ik>>Q*lk-wE%iO zp}H2xVe}gG9M}ck0{4NqrJ*7gZ!SLOKkOI5@8;F!TC_#MQP2$r06o)GenVRb>;W8D zD7%D?X>1yA1l$Eq5VsTRW$HmsrRS9N3?s%OWBc;_<(-zbmVl$&(ZE;mE#7y%#2I|A zjo-_M>|5-COg^&(FNdS(h@d$ui+4JY<>iuXB~8$FQ>Yet7={@`-z|XVq!8%A6-L7h zXZkW*Y%kgxgc{+N^ei+dvs3NASiGq?kdm6xkA7(0j)3{J)2Vr>-$2K0(qh|eJI>~? z-S8XD2h9u3$sbZ()UcW`^k4Z~-O_qL$X%C>Yh{0s&$y<|G zCsYX+NEa_@0BVSO|fZ7K>{)>%F;*p%GZWfJqXZcL@?De$k)Ai@j7tLK0p!gt{(Z0RSsF{(nin5TT zbJ+E|s}=jQ!|}4C!H{Fkx3jWj3D0quz)=(*-Q>TAA@q0g#NjT*< zo54cbdUP(b+3Z>8tIhz`XTrJ5*^o?gVtZOqT0HjOL_d@xFZ8<$#hQtnhjPAvjzQ>b zMGoCqu(2SR<^mx zQ9ivLybZR2#mFl$tYV4>{+}KYV}`&XcNx`SM2s8NRL4q0*@x*G|M}pk#B}IqDy#5^ zC~EHqe|^p*DKP-P)25nQ>Zu)vYOH;HddW$j$IE=W#veIjrC0@-)Nj934ol@YWKnwr Oa;S{rb}D0*y!;b<+O}B$ literal 0 HcmV?d00001 diff --git a/website/static/img/markdown.png b/website/static/img/markdown.png new file mode 100644 index 0000000000000000000000000000000000000000..ebe191814a47aec964bd92a2fa512cf1630776c7 GIT binary patch literal 7074 zcmdUUc{r47`2RB~snB*xG^q39IQAA3#n6H`qLL-l%!v@9EM>9`E!r@8Cn-cKRI(Hi zVRRHtDY6%1bWDk{j>Z_Xecz$qIe-8D_+7v2`(D>v^E}UcKllB)muI=}_sTv;TgAny ziva+Nu-&c$0LY+C8L(&}`u8)keHQ(b3)=x7T!cQ+i+nDleT9>Dhr$3@vQqlPfb>ii z0MvHDyQ~jJW{xsq%8nh2(U=(Tz5Nxte3|jNtIK~YseWs391yr;?+xhc@#lwKR+=Ok zT(KYVPt$}WF&aT(($RdT`jQ8wINn1PH zsGj-$C)_)Y-UVsv!xCOMfbn=iTfJ#XJm5>l9|P- zgtMruZpdkGX#dC4R!HH3Qy444X^3P@uYt!LL!%H+s*r@JAzoBg?Rr_&KQUX^(?7!> z9XK^Z2mp7d_EkasS0P#ktD%-z(k$0M0TtVG24KhG$rwQV6m3E;ht_CSmQrv(e#dMz zr+ZSX*VFqfsx3j;Kk-nSHpvY!`oOv9cN=UsqZ?`QpF*C#GgY9aY7~yuqtom;xYEd1 zA2yv$!s+nskU^b8>8}E1z)O8CGc$T6tnL`H8?w9)9DfVi&6j`J8|rvH@hq=I!fSl+N$Y<^w_%!o0JxVA577ZrBVMiJ<+#-C}5f|xPV6m zHRZ=pqm2umOc%S#M26+fgs%t0RapqDFPyT-vSE)_oQ_VV7JcQ}IR?14RPMOD_>x{B zsKzlWW-(wYq!^Od;n#d4zYr|0`vi+OtlW-Y1e%gY;bePUqYg=^U02b-QU=$2!>Y{0 z+in(vby+Mucv^kq20&b<43RvLZPdmhP;ID92JQ!=bj$`nN!)8?PVPjg3CRnAO4A28 z+39p4$Xte^)vp?8{lI6!;A7FX1wf@mk9t_4?)Jra0P4;3hNb~(Z1y(E8sHwJtYzk} z%WzwmF2vkb^rU8%-(XdCTnFI1IZ2lu_V_*k3nPRF5bpwMi<_7WITa?$0G0Or_OQ~E zxfT@ype0Kdr$sVm{Eh)uYULq&ICc@MKwZhrX`vH{+l`LKErijywO#>$e~KIcs?h)2 zp|V_a&~KuCe1xXFc;610l%U5-ce~4>;$o$H``750<(pqV`cg-(@VH3aHp@49uIp&U zUeg~77deJTM`$MTcOY%lUN@|r2`{_+d92v}vus@qd<47lQ_4@XeU36#ts>LeykSjM zPF{G7(morRy8Gq11#nyOwKnb+E8Qs2-hZ=H<1S%XOc@lnm3KCib@hOLz9~Z^W=Y~z zxj4pW9?nBAx%lIqWcq3Y}eiYsm_reGFgc(=Ljy z)Wi@i%HPDsJ%1>W4XalNTV8OVX%LSMi`54Hh4~~+l{YZ7k~n4ux)%vB>h=tcTiaFu z(*P8w9m>S)m~xzI?`99C^4&4K#eXnW4Z3PQEl(3McHow4fdC_wr;Q=5F3&9#fnjl7 zZ>hYMVz8^nXX!l8G5m=@kudFIu%^Ky4fxhm@~RRE>s2G=SztQZ>Z ze@ugiueg7GnwEVi;5CZ!PZVZL4!D9J^&2|gtr>C$wL4|32&<3bO1-1B?X zT&F~8P;nC`C2I{E96cQ-Yo_@Rl`oiG(E*MWy;0nBt=MNw5(D9zm*^Jnp5|Cx9r`8 zZpZYcoxuO5xistx)7ZHbXhGoM<36c=o9$(+o}YLmwS@BK4^lUnsGLRFNg`kTE6m&2 z$KVJ3wIh|ynUeqQSCA>h zEjf7vn{B9IS4C&GN}@w0$35ADwDz0BfO!7qxV$l6_6hYjuy*UgUvF;gjRP&33IJ@j zLvJsN=m}_bUb^Z0{~elWE|B%_c5;<30Y@@?+SXNcy6_~MM;p)npuDnZjSOUnV8=qG zd)E0{{L>N3em5TF3X&ivjqL#*JO(T_}=y!PU12G zXWC#>W$e}uUl7*RqwJTy8znCC`xqWPf4tXnt(^7xTKswyG9|quLRg+7n}3LQYnBw~ z`-|Iq!9Ro7ypO-yc2sD9D`3y$K+H`iN6H4@z~%X|ed(WtZdj{`KnAC_`#S4VVErL~ zJW@nSq8;`n8Ax^`vI&aW3F|UhJJr!NNE-%^J=w0qR5o?Qb8Y*%&p5iGiP*KZaf|4&H6?C!wFx)O#poBj z0`B`asn!O!?2ify^C*F{fpGFVj;6bRGt4P$Z+59^B6na8R&*A2;P5UgUH4{&RLFrt z>?*NObc<43j~+eZQFi{>jCo+51tIEop*Dy8!^RWCWBi4MMa_W%A%=4P&Cjg%=KVDv z=Xs4jBG)3Ul4n1@cl~ucsPQCwwz^!yj#K?r>EeQ^^CY43wrid5q>5%dpjfWWE-P2h zXye|VtniB=Fma6uuASp0(3uCZvBNRq0;RiE&x2cI&-%HC&aJgg4vp^ zJ4KX48eK8s4)ZpPE{k0`#l8^EO!2TVQZ$|SeMO&mmI+VmT?y}gvfoZcerY0NL^q0vcLkCgx=9yofw-J0u3Qwze zJ=60rrOhExOP44aGQ#%Hs8mcjHcCO*&N!*guE-@C)YL~3v zcp%@mio@7YHm9d=2c=lud}2p&@+3~Lqf25d!0)p0mp~N{VuddAra(z}+GfH1-FoZN z#@v%=pC8tWHQ>VytHt8+;C^rq3LfQV5N1YLTl`;F%^{Vk(7>82sKW} z+)ZrIcboWLlPX<)IJQ_gUY~$}`2MKyg9n!@@qcMb@64j4o^`V4aN8*rPv^1C{%Ffy z`*TskWT}aGc3+IhC}ez$@BZld4VLpG4L|RIZ_)tge#%$YB2A{qe<~ff=bTKWSso-v z-uFyHOy>C413#Ggv585KPh8E|$0jJXcJUzwh946LA8n zN^$4dUQUxbCF3t)rvMz zQo5i>@Pge|##O49IBm*H2hMy^NQ!fRJ|cY`@Fpq#>UCpn*KWRw)xGB z8tNB3{Bq0G)3dt=1+6i8JGn1zUvgEKZh0*t(Mg27_3ib-X8QwSZT^Q*(&GXm0bA#Q zMbI6Ol14f{r?tyZ{v9~W{PnB7KOVtjS0~+aW@iab8IAdeJf^<3Q>dhQ7rJl-F7UK! z|ID<{I3&?)Afyhn$rht(a8{oa&RABmf$Qzl=RuNg@u@Kqw(L4)R<%(BAs3~p8AW$^ zUh7JSf$neu+snf8d*NJ&xiKWgaE(!qn9K&IVTTBRLeN+`zCt^kG~6ty zo?nJix}Gf7F$;C}p|wn%3(t$HB>5)@_Mxn%sEZb6M%=;JF*J;BQW{Q+C8mtnI9lc; zTm4Sa82N1?;fzNEQz*zDvV=pICm&PKOkoX&XMcUQY6L?JQi4MdAu+x)>4FD>3nfqY ziuDsVQH4Pf%aXcr^h-xM*|#~zF8|Y6H7q6+){qk#XX2NyqfAyj8y07~L}@adF+bT| z2gpTh9{nH72R_fvd^K5fO0MxQ^eCy4_gj3pZd+$_9&sZkxnkLJ5d7(t7~=_N`YsE89i> zld2O2EcK&>QyHDZRyHiI2|q0bfTipk;Tmq}9thDqu)7Lw0R30xvEqWYz{`gqwLaHtXBsNw#TFz5XvwhvAU66GZ~{u$61c4c0rz&sF|!)(rr@*RO{S z>07A{Q{J5HZLXk!WTN;@Lfwj> zd9QCilEvaJ>EoeQDLc;Vb39)gX=Klvr0s-8&?~e+0{DGEb$d%&RJD<|cMiAYSqwjku%cIC_Y~ zsIrx<2=4bIZ$bf~HDGtIe29NBLfljdANjmfKQVCy%CKi{^+lc|M|mNE)RCURU5V%9 z0CAF$g(_5BJQ*^LRxJ_g!Yh|UQO8^xe>lRw5_hJN#ayKaz-Z*os$%6n#v#~{GJf3u zsvNkB@*nr*KufYLS_OPrt8m)6%7|~m$Ds*n%gsR@lHj96 zax?tBWV4+DxNFfv%}isR3x6p&K3D8|fL6TzZ?e{#$jCz_X_0L@7gBb$MYo~h_*{rL z-|EYS&bZBujpafW^R05UHUG9V7a||QE&#?4jr6rDbIcb5;yzr^o@WFk3JKCxT8LIR z&%;?SZm?=0w>9#zVCldx#KX_-uX8(SBLkLxAD|bF%giwTwgPcqqc_8*27>cO+9b!l z`k)Tfrm!mM-ZaIDd+F{VEabob*HN^)|?W zvuEJbj$*pE8$ei}hlXV{E+sAkKRW8+r7ajl)`$OLj9vI$kv^Nk1*oyxS42M_1P3_pY+W01@8-(fBAwC2u6jq(D4~{|a&o zlH$jcQ^s%-S_WF=7TlJgmt9HlUIXVHK=q;`gt}#Cniu2wE+Mc^@Il6W%2qhTMzvfz}vO%cJ=Ud>~S7SP=cT8R{&RCu-qz%zmfy;aanA zffx|@5=U=-Ac$ltI*I8Gd%(*mh|z}WLC{qHwL`W$057*^vP7_WKcZI}uO(sZ^^|c( zEnmHb(faz=mxCVI5awhf(WIM3y|ywF59_I!rKQ-e0RgDHhn7sQAzqoRBFnzJ&2q%b zm2EMPS`H1VYy4yZFv1}s1?csXZcFWL=cy^B0{w~*^a};&>78rwbCD3v6g!kNfo&DPK7bO_*!NW=YzEm+PD581dZVC zS9Q;Jk6$!t9(RkkjBz{vRt|^|MuV^oBNM` zO>W=1msz(-LPu>kACG=)emyK1Mq$kS{>6|FyV>WzCiPW=6?={4VtMqUuyL+CQMKKP zBC z_y9kKZ}S^2WoZSgrIX%Y7WT=7FkAdi&4nAin(F7!>bLlI zad%;`0_VCtII?k~c^oGAL;pGA1>8)hau$C?TS<@g{mgZC>m~Ds$S;;Nfm%jvh(Bv^ zWc2q_D#;wWq^}D6aJ{x`>DMhNb4=vj^~Ghat$)|ma18(-9c9${cv9cG_1nZ)I!$C@ z;b>;^?~41=@^+NP&B?`~$TO;N_rR3RWJ3#X`J1C5ZtLL>Tyy6w*{}XBDSn`g`z$k6 zRI+(=N|QoXlHK<5;^BE^vg7rLS(J5$>v-X-9+$&ehY#wC=rxk8+wPHQ@)^}~L^yTM z*gX5EoEY&j zM)x*O%t`~gIb^PRvIFUNE8C5{{WoEg>%8IogXg?v+~OcXJ@bO_kI{MX&b^=Ur8ap5 zLzM^H@qeToAlRnp9(SCP*{X88)`ma!r}+~8Ax+NjO?m)IE9p;)cX*rg^E?eD(xI}nUoX9T@c zTDjin?b!Li&vyO~&&v-&PFK1<*u%mJTJvstb`#z}2|2X$-pohBc(|dhhlh`0N9;5I zKIAIoeGXccKA%27c(qGVCvJk-&#@$PBD`rzXwl4CZ?E0<-E8i{14^l>bx$LDi1r7 z%0;l%=_~J|NK@5)W1(Yz(7%-$Uym%kQ{xRK#N!A#FEU@2x63!9qwKU zVXJ)dP*#QDI642NLU5Zv(vgdLzzMWYn8yXq$hp4BIvbiB{YflNlG}Yegy~!&t>Ig5 zm67BZ1kGoHW~eGj{EixxQci8B)!xK?T|Uy3wX|*Q;mr;L*ib-vo204mC5PZ0OQxd~ zw|_SWVU-i`1Y067GfD*%*+nf?-Y_Z_)feI(=7@$3TmB56G>VHfEvY0v$|}*pf^^q13O# zD;1VxwP#o-@SZU~W52|?``W{l_>EbGmIO8G*;|z8;SX#$z**tbgk6YA8B%QyUx6EQLD3G>p-2h|r=;Ru|X z6m6gaAXz+uV4^J+cAv$w;Rd!KESa}MRF=ck_-gB#hBS#UtM5tKVuh(masF_5_@d1F zkw>jZM~kBBXBs1V<`?2`$7vob?P18X7~~Z&g|w*DG|T{uE!V`ghZgp1e2ln8t2nD# zl%A@`_gz+C2lw!Jg5O#cA}%TACin+S_kp?PW`=kUmba?62TFN=i2SV+uF5aP<7&9YaQ$G)=(#(-@_2j^ z_a>asZZ&Kd>lf%hz2ZSTG(HS>fi=X4dgs1}pn^gW>@14Pk;xn#y)dLJ6_0pUBssR^ zcp_TP;GY3+tK(1l8QX1-n53OmY7~(p0N+m$!%S?mMv-Z#(7LKqTXnhf8*Tk?oTf@) zTOf00EEI9#cyV98Qm4Hv#i1CKYT0m7434vF|JCsr2+wm(e{b1aCxGF3v!=({#V_qQ zv)NL_uDBYs9w~uxhF2=2R)IEQC6?L#kY*(oOunSJ;I>U#!U0EWJFf`%ZJh*+sX?IG zJ6%9q+6=*sv0JEvu+OHJ1h!#bm%kC#K{zFvTh{WYQi1s>r(N^if`5S57&O3wb@C6X z3)tBi8w4<4+1`sfB>g7YRX;f$uG;Ru^4iNuM!&PLO}MY=#^ki3mrZ|NkQAn($L4NM+QOgfP5ES7HcrN79&3;BPjl(%C9=VK z>GgLpML$ZVfp$`9!usvKs^-Od3(op8jS{rx;~Gtjy;o$%ecB7peBabb6fs3O)`CQh zbK}*&No+KVNclVAy)5PA+Sg|rmm))_)@rsBKZps`32zXFKZ_!sd<*1eqLDnC#N{R? zn9k12IZs6IdbJb3zL_+P&B~CjH{$({?P7;O^{K^gS1l{bP3FBI;9rdYaWs>8yf~l5 z3|m*L%7pD_kA(c>BU1sBM3ZEwzS zesj$`-(d5N=A&k7&Iyb7c6-$6;ep;pRqrPd?VT1%TF?wP9+(48H+*|mO9K-%ifA6K z>K=l?Tvn7v3^J<$#rpky29Pu$CvGdVB0`{J8HM|%pFX}6d993VlJC1XaxYzs*|lU>SdQGd-GTElbov>rBf*lJdBvr6wJ#nIa9nAhNQrlQjnK!6JI z#RNLSVZXyLSJj1|M+7|B96yL&afRx=9TcH9wDxvVEJB@zJ$XF&340D+m zp(0N^2YY%2RCv;&mFhU*PbK(0gDvMq{gq1un})l2iQI)ZtuB9$vnRb{%2=JNA8Zea zdYR;^$IO>)F`T;Uc(eFbjVlNH&f`3ek9DGViCYFu*tN%~of0*SZ1fU}jj1!BV?kr) z`_ZoPRqS~MuZplsP_mA?O#QP#sQx}EQLdh-dATJV-sC!z-e=vqdz=Un8(v%G{UCLo zQyoyx9e|i-h}k7%83`I_!+Tui|GfsA=JT%v+?*fe{60Ua?RvBh>7uLXOZLv(7@UTD z3|=4(OMX+tR(fREd#He?df1?~a~Q)O?GpPf_Yg75nMeCCh`kPrJ|)S#ReK65 zf>F*+y2wb+`(q~`S%qxApf2(u1q1O{KpeT(uUd z-&P9KIE*azsj;=*^^97PATOLUrZD7jOo(yP@n_#}u%fgR6srfxoA-8qV{jUx8{@m& z@743!eYtYPZyAgYN2^t_v*=t8Sv`8SxnA#W32Oj9Cer( z#e0t|wp%dy+1~*iN)FF+gHS!BKdd}Uh5y6=YhK-ni|E@u!iPJphfKeD+Q4HLHX9-k zp-9e^2ab#78{}*KeFwg@4-2%;#zekf1wAsDBE@pYQfkvN6|NANtMfxywcGSlwmMwb z03ty+WrY%5Sjiu|Tuj4|*2zwGUSSAk=3kygG+lD6+5443Zmtz@FAgQ)oS-a3iZ&ze zKDyg4y;M3u0$iHPY-KR2XBKl)EF?rM-fGd=T*r`)O!$hbIV)UJooQ{3#;akv1Ln=4 z;e?g4?tV?vS;_D_l;b)?6wet2i}t{Kp4t?nnneH6lC$j#)QCBF?|c(p*j(ZSBL9Y5-Lkzf&{=ZfX!zA{ z1B{6l&@@FtiDOyvnjSa0#Gg;a4YjJ!cR3_JlqN0gf%hC1SBRrRF@`$7oeEQ$*N33t zXS5l2iCjQhj0<+Oft-XUWN=s1iLDlCVPz;c>FSR=aThcj0#Q63lfI`C^sKQd=*upk|!gfan#Dw+h)0hJ<6NHI_;T9Da2}J_-I5 zTOKMs-upazPmB@cO(dAQ2Q^yi5gR}Y?%IbgM>n@SuC0R`SKh1GvFq)a%yH;wQ(9H= zv~cX)d%wsP0S_>!RT&1lrzTpx*T6+xQ^P8_;oY1-f%3-doUJ94_sO(y*{uEk`pFtY z`pIYA(C{9%!Mi*d3r8 z5Y#=R4BqZ`e$`T1sl=s59U7f8B{2>$FD#tvcg=m@oszv5bAIj>7iRqA2)9CcV6_^HrivzPV6>sA%qRpwSm$P&8VqE^Uj z#nZmh9N_~Fbh6D)Jq>C5n9fPHg2+3!brEr4fU5_&kj|7i%+1wkJ`W>nLsCz!( zC`K*^tE%sV-nY=EyzfCu={1$2vlZf3bdub=e$C3RqY@Vb^#juKOFGaf-L;j`q`&}&gRyi@O=g?XV(Oe;W2xbz_|Dw; zae62g+mwB#c56Q+MttPga=R29Zs^N0_6RhBSMeQ0C;%F9Y`y4)Fys`Hxn!fr4sl`s zXB8j&4l{T(e(-D;$*i8YjCw7MdC**^QXX_Y|MiE(`AL1~X24c)!x7WBg1b}tS^l13 zHi45I{jki&J8pJS6WJzjYx=q`#QFE1PfM@N(520M@R^;8nusOHrb%c;{~M4>Di_}f z;==FE#s9XUfU2l=q_w2nV2E-NyiYx}ATit}8KyLIniXv@W#_YX1>5CBo`ST4b9_ur zRQ=jRg~qX%-!{}dM={C^)N(@iLxS$NrIu36qm$EpX5W~PRlco`Sm+0&6ctVoLeP(G zVfeRdqcLi{I`-~PAfQAm=pC8(?wVfoj_!Jr{pX5OnMp1gyaEN1bJZ*2#i;)usE?RC zDMlU+#v{S_LmF8pVsZEy3Gw9ex@%qogY8SY-5vR@Nq@fYfF_Aii z_(&a)X{7BB<>}4X4Tv3m*xToFgsa`ss(k6G&$;%zj8D~=t=)t8j`EJC!`F%iXR4C@ zIzL}+T@+RuQU<$zKnD))THjO{PMCuOG$%DZWi#UOEtAE&sX)939hgfWGF3f^3+HKE z0ZIboHb}~0an>mo$n9teeM)|(+sLLazG*l?W>+%a1CWt@oOUpR&aX^Rf+6TvqJVIy zyM7e9qw zr3|*^zUH9FzK;QV{fc}y6fkVXU57B10QDQdK}cs8_4Bk@1-g4rZlY{@m)xvC(ZlkBAF)+V{=iPA5zJ1?S};O zB*b9TAR<`k#4_o-9%-{<=u#VZOI~;kdS#-^XQ|}?%Nd$X4$(hZb)XRBJKfnL5vg(lSMoQ2GblhKsNG@SJkW^j zq1ScCMIezKsjf0tF0dHvr+>y^v0i6<9_PL&R>bsNe!SAwP9jW>jKad!?6Q164AIB} z{&W4dq0`ABFPXNqekG2ls^qf=<&XV5#*)=ai;dFTb_OLdu9ZoRyYYYy;c41Q$0u&D z{HCPtTbhNw%7;H@0npoP?YOCa!R!;K4dh$~aKR>-82B{xFHB9Y7-&&MyZ}n;nl{O- zL;)hinkh^Zc|>Fw# z(gDZ@{;)K*~IO6`6aXF z1^8-GHQlW}vRkM7A&XWA0X;6B41yhFJ?FZlZP?jL)>vVf<(1a(1P!0obC;geeN<+_ z)-;>gcsFz@y8EN>Oiz>2wz!``@89ZE-m@Rjm(HnZ@Qtt(2J~`_*2iTZs-ZejGQBB_ z-UsE*BnAtDZV*V+Ip_}u@6=J#=8HpL^2pn|Z^k7++*_V?juT4AMm_6LHuOnjXH^|=Y3mYi(T#>|us#=Z^H25`0-68~23 zCh=CX$Wybf-chV`;?S>6+0mmWFS>#J7a*Crhp>aD?U}6Ud9NSFC29J!Wk;6=(_h5l zTL=X#H5!(B;Mbn%v?Cj4$DSS9t94t^jp--`R7F%7-ZNiIg=?$ndkqJ%M5(-v=NE3$V= zLL*Y60PLb#6n|)CZm!|N-|p`{5dLZt=xb@*{2;R(2K_s`^?-DV=pnv*t( zswZWS$iTsH7)WEi_^PvDgh2*sLBKDM(ySqL>F661I9R`gqeDetqwhYgW6C_!>@55K z-XhU_7xs zgiSeL%CsBhO3Sy;kQL}Hv37$jxrgN?Sylg*M)v_OQ!BYODK5zU0-%Jb7=*x^`Y`={ zn_#pPWi8?Lv9!>fiDHmqu?n~PMd z09PAfH(y=1_p1`N=SvZX@9zFiA6sKE8ay#}p_pnl1*=0DJQv{bEQDPh;2cnr1(R8R zU3xjh!hM#3C~~f<<~PotqpqPZ3Pa*-e73u=Kqv0H`$(zZ6^X^ z;I}~`M1kd@4v8X-**relrRT~ufk76C%5$0t80cEqma+EFv z{b2m46oUp^xe11=y5den$3l87VzGk9IdZaUm_{vDppmEY;a^^WDkbo2R~-I+Taoh& yG7&N*Y*=UoGCebe;qtxp?AU+5!ti*)kjgWTM{4XA`T(zHKqdwjmrC?p9{eA^tCv;) literal 0 HcmV?d00001 diff --git a/website/static/img/react.svg b/website/static/img/react.svg new file mode 100644 index 0000000000..d338d72f1f --- /dev/null +++ b/website/static/img/react.svg @@ -0,0 +1,21 @@ + + + + + + + + + diff --git a/website/static/img/translation.svg b/website/static/img/translation.svg new file mode 100644 index 0000000000..9588283380 --- /dev/null +++ b/website/static/img/translation.svg @@ -0,0 +1,3 @@ + + + From c6503c4bfa8429615acd71c7c43ef36fe718269b Mon Sep 17 00:00:00 2001 From: Frank Li Date: Fri, 28 Jul 2017 16:59:41 -0700 Subject: [PATCH 2/3] Use template strings, update React components, and update package.json files --- lib/build-files.js | 3 +- lib/copy-examples.js | 0 lib/core/Prism.js | 78 +++++++++++++++++++-------------------- lib/publish-gh-pages.js | 0 lib/start-server.js | 3 +- lib/write-translations.js | 0 package.json | 2 + website/core/Footer.js | 48 +++++++++++------------- website/package.json | 10 ++--- website/pages/en/help.js | 14 ++++--- website/pages/en/index.js | 41 +++++++++----------- 11 files changed, 95 insertions(+), 104 deletions(-) mode change 100644 => 100755 lib/build-files.js mode change 100644 => 100755 lib/copy-examples.js mode change 100644 => 100755 lib/publish-gh-pages.js mode change 100644 => 100755 lib/start-server.js mode change 100644 => 100755 lib/write-translations.js diff --git a/lib/build-files.js b/lib/build-files.js old mode 100644 new mode 100755 index 5d8c5e47fe..f67b3ebb48 --- a/lib/build-files.js +++ b/lib/build-files.js @@ -10,10 +10,9 @@ */ require("babel-register")({ - ignore: false, babelrc: false, plugins: [require("./server/translate-plugin.js")], - presets: ["react"] + presets: ["react", "latest", "stage-0"] }); const generate = require("./server/generate.js"); diff --git a/lib/copy-examples.js b/lib/copy-examples.js old mode 100644 new mode 100755 diff --git a/lib/core/Prism.js b/lib/core/Prism.js index 64940726ff..24743a082d 100644 --- a/lib/core/Prism.js +++ b/lib/core/Prism.js @@ -18,17 +18,17 @@ const React = require("react"); // Private helper vars const lang = /\blang(?:uage)?-(?!\*)(\w+)\b/i; -const _ = (Prism = { +const Prism = { util: { encode(tokens) { if (tokens instanceof Token) { return new Token( tokens.type, - _.util.encode(tokens.content), + Prism.util.encode(tokens.content), tokens.alias ); - } else if (_.util.type(tokens) === "Array") { - return tokens.map(_.util.encode); + } else if (Prism.util.type(tokens) === "Array") { + return tokens.map(Prism.util.encode); } else { return tokens .replace(/&/g, "&") @@ -43,7 +43,7 @@ const _ = (Prism = { // Deep clone a language definition (e.g. to extend it) clone(o) { - const type = _.util.type(o); + const type = Prism.util.type(o); switch (type) { case "Object": @@ -51,7 +51,7 @@ const _ = (Prism = { for (const key in o) { if (o.hasOwnProperty(key)) { - clone[key] = _.util.clone(o[key]); + clone[key] = Prism.util.clone(o[key]); } } @@ -62,7 +62,7 @@ const _ = (Prism = { return ( o.map && o.map(v => { - return _.util.clone(v); + return Prism.util.clone(v); }) ); } @@ -73,7 +73,7 @@ const _ = (Prism = { languages: { extend(id, redef) { - const lang = _.util.clone(_.languages[id]); + const lang = Prism.util.clone(Prism.languages[id]); for (const key in redef) { lang[key] = redef[key]; @@ -92,7 +92,7 @@ const _ = (Prism = { * @param root The object that contains `inside`. If equal to Prism.languages, it can be omitted. */ insertBefore(inside, before, insert, root) { - root = root || _.languages; + root = root || Prism.languages; const grammar = root[inside]; if (arguments.length == 2) { @@ -124,7 +124,7 @@ const _ = (Prism = { } // Update references in other language definitions - _.languages.DFS(_.languages, function(key, value) { + Prism.languages.DFS(Prism.languages, function(key, value) { if (value === root[inside] && key != inside) { this[key] = ret; } @@ -139,10 +139,10 @@ const _ = (Prism = { if (o.hasOwnProperty(i)) { callback.call(o, i, o[i], type || i); - if (_.util.type(o[i]) === "Object") { - _.languages.DFS(o[i], callback); - } else if (_.util.type(o[i]) === "Array") { - _.languages.DFS(o[i], callback, i); + if (Prism.util.type(o[i]) === "Object") { + Prism.languages.DFS(o[i], callback); + } else if (Prism.util.type(o[i]) === "Array") { + Prism.languages.DFS(o[i], callback, i); } } } @@ -155,7 +155,7 @@ const _ = (Prism = { ); for (let i = 0, element; (element = elements[i++]); ) { - _.highlightElement(element, async === true, callback); + Prism.highlightElement(element, async === true, callback); } }, @@ -171,7 +171,7 @@ const _ = (Prism = { if (parent) { language = (parent.className.match(lang) || [, ""])[1]; - grammar = _.languages[language]; + grammar = Prism.languages[language]; } // Set language on the element, if not present @@ -209,20 +209,20 @@ const _ = (Prism = { code }; - _.hooks.run("before-highlight", env); + Prism.hooks.run("before-highlight", env); - if (async && _self.Worker) { - const worker = new Worker(_.filename); + if (async && Prismself.Worker) { + const worker = new Worker(Prism.filename); worker.onmessage = function(evt) { env.highlightedCode = Token.stringify(JSON.parse(evt.data), language); - _.hooks.run("before-insert", env); + Prism.hooks.run("before-insert", env); env.element.innerHTML = env.highlightedCode; callback && callback.call(env.element); - _.hooks.run("after-highlight", env); + Prism.hooks.run("after-highlight", env); }; worker.postMessage( @@ -232,25 +232,25 @@ const _ = (Prism = { }) ); } else { - env.highlightedCode = _.highlight(env.code, env.grammar, env.language); + env.highlightedCode = Prism.highlight(env.code, env.grammar, env.language); - _.hooks.run("before-insert", env); + Prism.hooks.run("before-insert", env); env.element.innerHTML = env.highlightedCode; callback && callback.call(element); - _.hooks.run("after-highlight", env); + Prism.hooks.run("after-highlight", env); } }, highlight(text, grammar, language) { - const tokens = _.tokenize(text, grammar); - return Token.stringify(_.util.encode(tokens), language); + const tokens = Prism.tokenize(text, grammar); + return Token.stringify(Prism.util.encode(tokens), language); }, tokenize(text, grammar, language) { - const Token = _.Token; + const Token = Prism.Token; const strarr = [text]; @@ -270,7 +270,7 @@ const _ = (Prism = { } let patterns = grammar[token]; - patterns = _.util.type(patterns) === "Array" ? patterns : [patterns]; + patterns = Prism.util.type(patterns) === "Array" ? patterns : [patterns]; for (let j = 0; j < patterns.length; ++j) { let pattern = patterns[j], @@ -319,7 +319,7 @@ const _ = (Prism = { const wrapped = new Token( token, - inside ? _.tokenize(match, inside) : match, + inside ? Prism.tokenize(match, inside) : match, alias ); @@ -342,7 +342,7 @@ const _ = (Prism = { all: {}, add(name, callback) { - const hooks = _.hooks.all; + const hooks = Prism.hooks.all; hooks[name] = hooks[name] || []; @@ -350,7 +350,7 @@ const _ = (Prism = { }, run(name, env) { - const callbacks = _.hooks.all[name]; + const callbacks = Prism.hooks.all[name]; if (!callbacks || !callbacks.length) { return; @@ -361,9 +361,9 @@ const _ = (Prism = { } } } -}); +}; -const Token = (_.Token = function(type, content, alias) { +const Token = (Prism.Token = function(type, content, alias) { this.type = type; this.content = content; this.alias = alias; @@ -374,7 +374,7 @@ Token.reactify = function(o, language, parent, key) { return o; } - if (_.util.type(o) === "Array") { + if (Prism.util.type(o) === "Array") { return o.map((element, i) => { return Token.reactify(element, language, o, i); }); @@ -395,11 +395,11 @@ Token.reactify = function(o, language, parent, key) { } if (o.alias) { - const aliases = _.util.type(o.alias) === "Array" ? o.alias : [o.alias]; + const aliases = Prism.util.type(o.alias) === "Array" ? o.alias : [o.alias]; Array.prototype.push.apply(env.classes, aliases); } - _.hooks.run("wrap", env); + Prism.hooks.run("wrap", env); env.attributes.className = env.classes.join(" "); @@ -1100,7 +1100,7 @@ Prism.languages.yaml = { const PrismComponent = React.createClass({ statics: { - _ + Prism }, getDefaultProps() { return { @@ -1123,10 +1123,10 @@ const PrismComponent = React.createClass({ } }); } - const grammar = _.languages[this.props.language]; + const grammar = Prism.languages[this.props.language]; return (
-        {Token.reactify(_.tokenize(this.props.children, grammar))}
+        {Token.reactify(Prism.tokenize(this.props.children, grammar))}
         {lines.map((line, ii) => {
           return (
             
- Star - -); - class Footer extends React.Component { render() { const currentYear = new Date().getFullYear(); @@ -31,7 +17,7 @@ class Footer extends React.Component {
{this.props.config.title}
Docs
Getting Started @@ -53,17 +36,28 @@ class Footer extends React.Component {
Community
User Showcase
More
- GitHub - {githubButton} + + GitHub + + + Star +
@@ -73,7 +67,7 @@ class Footer extends React.Component { className="fbOpenSource" > Facebook Open Source @@ -28,10 +32,6 @@ class Button extends React.Component { } } -Button.defaultProps = { - target: "_self" -}; - class HomeSplash extends React.Component { render() { return ( @@ -39,7 +39,7 @@ class HomeSplash extends React.Component {
- +

@@ -52,12 +52,10 @@ class HomeSplash extends React.Component {
@@ -98,21 +96,21 @@ class Index extends React.Component { { content: "Write all of your documentation and blog posts in Markdown and have it built into a website you can publish", - image: siteConfig.baseUrl + "img/markdown.png", + image: `${siteConfig.baseUrl}img/markdown.png`, imageAlign: "top", title: "Markdown Documentation" }, { content: "Write the content of your main pages as React components that automatically share a header and footer", - image: siteConfig.baseUrl + "img/react.svg", + image: `${siteConfig.baseUrl}img/react.svg`, imageAlign: "top", title: "React Main Pages" }, { content: "Translate your docs and your website using Crowdin integration", - image: siteConfig.baseUrl + "img/translation.svg", + image: `${siteConfig.baseUrl}img/translation.svg`, imageAlign: "top", title: "Translations" } @@ -127,14 +125,14 @@ class Index extends React.Component { { content: "Support users of all versions by easily providing documentation for each version of your program", - image: siteConfig.baseUrl + "img/docusaurus.svg", + image: `${siteConfig.baseUrl}img/docusaurus.svg`, imageAlign: "top", title: "Versioning" }, { content: "Provide search for your documentation using Algolia DocSearch integration", - image: siteConfig.baseUrl + "img/docusaurus.svg", + image: `${siteConfig.baseUrl}img/docusaurus.svg`, imageAlign: "top", title: "Document Search" } @@ -149,7 +147,7 @@ class Index extends React.Component { content: "The provided site template lets you get a website for your project up and running quickly without having having to worry about all the site design. Provided example files help you configure your site.", imageAlign: "right", - image: siteConfig.baseUrl + "img/docusaurus.svg", + image: `${siteConfig.baseUrl}img/docusaurus.svg`, title: "Quick Setup" } ]} @@ -163,7 +161,7 @@ class Index extends React.Component { content: "Use a local server to see how file changes affect your website without having to reload the server. Publish your site to GitHub pages manually using a script or with continuous integration like CircleCI.", imageAlign: "left", - image: siteConfig.baseUrl + "img/docusaurus.svg", + image: `${siteConfig.baseUrl}img/docusaurus.svg`, title: "Development and Deployment" } ]} @@ -177,7 +175,7 @@ class Index extends React.Component { content: "Docusaurus currently provides support to help your website use [translations](/docs/en/translation.html), [search](/docs/en/search.html), and [versioning](/docs/en/versioning.html), along with some other special [documentation markdown features](/docs/en/doc-markdown.html). If you have ideas for useful features, feel free to contribute on [GitHub](https://github.com/facebookexperimental/docusaurus)!", imageAlign: "right", - image: siteConfig.baseUrl + "img/docusaurus.svg", + image: `${siteConfig.baseUrl}img/docusaurus.svg`, title: "Website Features" } ]} @@ -196,10 +194,7 @@ class Index extends React.Component {
All Docusaurus Users From b71ef8c0f19e7d2318ea147c48b0967c1a218cc7 Mon Sep 17 00:00:00 2001 From: Frank Li Date: Mon, 7 Aug 2017 10:34:53 -0700 Subject: [PATCH 3/3] Update website setup for new API --- docs/{en => }/doc-markdown.md | 5 ----- docs/{en => }/getting-started.md | 4 ---- docs/{en => }/search.md | 4 ---- docs/{en => }/site-config.md | 5 ----- docs/{en => }/translation.md | 5 ----- website/sidebar.json | 11 +++++++++++ website/siteConfig.js | 2 +- 7 files changed, 12 insertions(+), 24 deletions(-) rename docs/{en => }/doc-markdown.md (93%) rename docs/{en => }/getting-started.md (98%) rename docs/{en => }/search.md (90%) rename docs/{en => }/site-config.md (97%) rename docs/{en => }/translation.md (98%) create mode 100644 website/sidebar.json diff --git a/docs/en/doc-markdown.md b/docs/doc-markdown.md similarity index 93% rename from docs/en/doc-markdown.md rename to docs/doc-markdown.md index 10c14efde3..760d74d992 100644 --- a/docs/en/doc-markdown.md +++ b/docs/doc-markdown.md @@ -1,11 +1,6 @@ --- id: doc-markdown title: Documentation Markdown Features -layout: docs -category: Docusaurus -permalink: docs/en/doc-markdown.html -previous: site-config -next: translation --- Docusaurus supports some extra features when writing documentation in markdown. diff --git a/docs/en/getting-started.md b/docs/getting-started.md similarity index 98% rename from docs/en/getting-started.md rename to docs/getting-started.md index 213eea2d43..0425edc88f 100644 --- a/docs/en/getting-started.md +++ b/docs/getting-started.md @@ -1,10 +1,6 @@ --- id: getting-started title: Docusaurus -layout: docs -category: Docusaurus -permalink: docs/en/getting-started.html -next: site-config --- ## Getting Started diff --git a/docs/en/search.md b/docs/search.md similarity index 90% rename from docs/en/search.md rename to docs/search.md index 23f4237e44..71b78bbd66 100644 --- a/docs/en/search.md +++ b/docs/search.md @@ -1,10 +1,6 @@ --- id: search title: Documentation Search -layout: docs -category: Docusaurus -permalink: docs/en/search.html -previous: translation --- ## Algolia Search Integration diff --git a/docs/en/site-config.md b/docs/site-config.md similarity index 97% rename from docs/en/site-config.md rename to docs/site-config.md index c63026375f..6297ebec57 100644 --- a/docs/en/site-config.md +++ b/docs/site-config.md @@ -1,11 +1,6 @@ --- id: site-config title: Customizing siteConfig -layout: docs -category: Docusaurus -permalink: docs/en/site-config.html -previous: getting-started -next: doc-markdown --- A large part of site configuration is done by editing the `siteConfig.js` file. diff --git a/docs/en/translation.md b/docs/translation.md similarity index 98% rename from docs/en/translation.md rename to docs/translation.md index 2c989e416a..24d8ded293 100644 --- a/docs/en/translation.md +++ b/docs/translation.md @@ -1,11 +1,6 @@ --- id: translation title: Translations with Docusaurus -layout: docs -category: Docusaurus -permalink: docs/en/translation.html -previous: doc-markdown -next: search --- ## Overview diff --git a/website/sidebar.json b/website/sidebar.json new file mode 100644 index 0000000000..c90bc7748b --- /dev/null +++ b/website/sidebar.json @@ -0,0 +1,11 @@ +{ + "docs": { + "Docusaurus": [ + "getting-started", + "site-config", + "doc-markdown", + "translation", + "search" + ] + } +} diff --git a/website/siteConfig.js b/website/siteConfig.js index 537bd95ba1..6d1029abee 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -29,7 +29,7 @@ const siteConfig = { headerLinksInternal: [ { section: "docs", - href: "/docusaurus/docs/LANGUAGE/getting-started.html", + href: "/docusaurus/docs/getting-started.html", text: "Docs" }, { section: "help", href: "/docusaurus/LANGUAGE/help.html", text: "Help" }