From be1ea7223718d17b670751a064cd3e17429da4fd Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Wed, 13 Dec 2017 15:27:35 -0800 Subject: [PATCH] Add About Slash page (#282) It will show up in the header as "About/" :) --- docs/guides-custom-pages.md | 4 ++- website/pages/en/about-slash.js | 44 +++++++++++++++++++++++++++++ website/siteConfig.js | 1 + website/static/img/slash-birth.png | Bin 0 -> 11897 bytes 4 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 website/pages/en/about-slash.js create mode 100644 website/static/img/slash-birth.png diff --git a/docs/guides-custom-pages.md b/docs/guides-custom-pages.md index 2b56549e5a..0facee2b91 100644 --- a/docs/guides-custom-pages.md +++ b/docs/guides-custom-pages.md @@ -3,7 +3,7 @@ id: custom-pages title: Custom Pages --- -You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding `.js` files to the `website/pages` directory. These files are React components and the `render()` is called to create them, backed by CSS classes, etc. +You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding `.js` files to the `website/pages` directory. These files are [React](https://facebook.github.io/react) components and the `render()` is called to create them, backed by CSS classes, etc. ## Customizing Your Home Page @@ -35,6 +35,8 @@ root-of-repo Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). +> If you want your page to show up in your navigation header, you will need to update `siteConfig.js` to add to the `headerLinks` element. e.g., `{ page: "about-slash", label: "About/"}`, + ## 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](api-pages.md#using-static-assets). Alternatively, they can be placed in the `pages` folder and would be served as-is instead of being rendered from React. diff --git a/website/pages/en/about-slash.js b/website/pages/en/about-slash.js new file mode 100644 index 0000000000..3b08cccce0 --- /dev/null +++ b/website/pages/en/about-slash.js @@ -0,0 +1,44 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +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 AboutSlash extends React.Component { + render() { + return ( +
+ +

About Slash

+ +

+ Slash is the official mascot of Docusaurus. You will find different variations of her throughout the website, whether she is moving fast on her scooter or writing documentation at her standing desk. At Facebook, we have actual Slash plushies -- and you never know, you may see these plushies at various events and conferences in the future. +

+
+ +

Birth of Slash

+ +

+ The team sat in a conference room trying to come up with a name for the project. Dinosaurs became a theme, finally landing on Docusaurus, combining documentation with those many dinosaurus that end in "saurus". Of course, we needed a logo for our new project. Eric sat down and designed a logo that was quite beyond the norm of our normal open source project logos, but yet was just so awesome, we had to use it. We needed a name for this cute Docusaur. "Marky" for markdown? "Docky" for documentation? No, "Slash" for the normal way someone starts code documentation in many programming languages // or /* or ///. And Slash was born. +

+
+
+
+ ); + } +} + +AboutSlash.defaultProps = { + language: "en" +}; + +module.exports = AboutSlash; diff --git a/website/siteConfig.js b/website/siteConfig.js index e68ba97921..a72872ea15 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -78,6 +78,7 @@ const siteConfig = { headerLinks: [ { doc: "installation", label: "Docs" }, { page: "help", label: "Help" }, + { page: "about-slash", label: "About/"}, { blog: true, label: "Blog" }, { href: "https://github.com/facebook/docusaurus", diff --git a/website/static/img/slash-birth.png b/website/static/img/slash-birth.png new file mode 100644 index 0000000000000000000000000000000000000000..070bc53f803fd01915a943527e1d9485c3b47230 GIT binary patch literal 11897 zcmd^l=ObKU(>EKUB?v+EPNGMNZb^t3=E9>iVCut7#N^);ByA*}jpb1^>!Ws)evK4-s@#>BH= z#$)WYZ@e3_z`7CO6oml=tMK3Dozj2A6&V(99-7b|KN%uTp2#K5Q2s5{|6{|+u5h}a(kiva@@ zR~iFEY=aM)&)vXI{jW>FM`IAKk15ve5B_sQ@BtGTXqv4ViYLG?OF`b8rGnTzD{oB7T0z?$G-M83cb^1|0}#Ry>9S zPQ{pdv?m2cpl)o8zQZOi7Cu2VbO;{i!vImqqi=fg?kPNZ+#kdKeo^nK>%hDfJcffg z$j$s)%~vo`7mW*l=@LAVr7n#fY`s2u+F3?qIXv2Vg#FzYd5H?kL!k=WMKX3S<$tlr z=f>nZuUhRNMQiO7hnCBx(*!#v{N~t*cGs8%FGlh`3{NcJR@x$mq;ny&lRVARDp5rR%)lo zGS=-n`-lJ;*YDR0(5U55GJgz_E;*jn87rdq{p4Og^lv%Bg% zhZ&XkjQcU(`OLBDI?F$2#bbb4svEti(1v^?exy#Ak7_jB7+3Psc9js&jrwSDCcbdZST~n`YW^@E-rlhx$X|*fwku1 zBOqd}*TjHCBF{8@K%z8ZxD?yr-^Ai=ufY0=cM0s_^NX6IuHAldCrt@G((fX+<(*1} z1E_jNuHi*d(E-lEdl3p^@f-~wlN*&kp>rI1$skR0efbE-5EB!(5(C;cC3O;kVBY>{ z#@MZ*4Y|H%Hy&;-U4L`vb*IAqU{dR$Pg=(1FnexzQPbPz)3tCdwV9D}88PvJXq_h5 z$i{h^OW^|DZ5;C%0KAZWR@6bqAeWRcqyago>sR%+waqWy#!iE9GkZ+O#JXW}=Q?fi zDx9>V>fzbM7tMC0E$#NICwZeWkJ0;PE&`tDhPSW0m<+xLH%-uy+{PtV9Rq46CBF9= zuwNt6AMdK+^rk9t|9UMD7S+C+SGzRt*wvAZh;xO-!OkiR-j;A~sZQ|{tzB-x4lf>@ zpGf&v5&I2^{19=n3+E}rZ z8$0$BOwQ(*w|VPi8|ROVeerb%uy2?7I2b?)i}AxRXlq!Yly@%-8|EHP_cXSv>AV7* zZ&hGMW|&md*B8@}=JgT+8MR(b^}GrC@Z!h!1X1)u7*Hw_>4iz+XAwX^l9Hvlgfbzg zW_o%l4|Z*Ge~2~w@a>Pi>faiw_~hXCcUV5Bs7P5&bTu}G-*et8uMw#ZW`O+hC8Qv{ zO-mdA_dXiy-+|25B6$={KQ-NAiw6WV`E(Dj7?mw%_)|qALINF!5THb zMw8WcJ(_-+ALNF2LuHwcTJI2bHJ#0KZn_!HABKB&S%a?(E;i)B9Oe2dnZx<-3@T*z zD8m#khW~~*5@Iu=iOHNC2!X-Edo))`Kf&U7Hyp6{KTsjW=_0KTPXg^LDPcuPoqU>pe*|X|KxCrg;+Ek=912SD(_P)yjz=2LYuv z!i-McY#orJnDp3&z53p&dB4LDvsewh*F0I@Yj#z^W z#hYTn>lZY)G$8GOYu*OCZ=D807gkPnCaK`O{Pd1~mU%F2 zf4ouN^eb(2XbgBB6?M1^WL2=s19VoM;4&N(b;c(#VnE56%bHN^72u;;18>@m`yuQL z$L{9rQqCYDs1qn6U4=U=eK&vA1$&wRDLoZ`H=|6H>PsP z<|!FP3gY7n4oUuMW`ym)zlP*KpvE5KyF9Si5}DRt7HN+!!~-f$j9S>CdqctB1~xCj zwAZC6(^bRnqj*@LHxFEnaT;aQrcdWJ?I-s?Rw4Z09o}H|BP%N@R z(0UJ7btOj%%Q!7b4f#WPEfrj#UDPisNa|3qWFGVC&C2;ArSnvw_msji%X~ z_X9+dqA9xDjaF4->F~JN(_dP+xoK5`j}rF&y!MiM_E>&-cC~U3p~s%f*v(*v;Jm%4Y@!G;r}`=}hWzfl9G-aED0K(0+ces>|~+_7gpfupX_K-@*`FvtJ~( z?mmpEYN-gfuUH$WE|!YU_<7A!}s53kbEbx(V8^^z`Lo)Bg9z;jGK zs_b$&J;zbFG|m*cF47i(zg;Wk{hZZueD|X}DQ2Md+G8Por7>{7 z_-|G|K+Av}HULasWM~I!C$@&SnJI7y87~@g>Y2d6%=;#!F})NlauiJ^c3VfH6;D&5 z*WXP0IlikxSOhfi>X1E(Lwh?P13D)(!l}WigN~++J81hOPjtIO-q`Brk?|juKFG>f zb#Gpuv?Eu%-^C2UBZ(W?v2ke0Yp_;U4YMwt(Jn9h=?!o3nywc<2GDWVd z(2^LGfE`ZDmbF0&d|7ZYyIQtWO_6niYUMqFa@Ofp>y6|+@oF5*9kJp3r1bM^7=c>Xi&!R z7zQ~Zxj63>?wP5Y?yeL_u9suqnST_~V{+raLsSwULf+zO^&tF~fipe<+pm8;nsgB< z-(gCX|9*r7)0&g1TI zHQ(IT3^z_y>DtfbcTt|a^pO+60epf1B4b&ov$XiYUn_%Ml*56(QX;?52&L~T9XPgp zT&uFQ`E`e;cGhIv<1r+|;t{=brb`t|?jH3dQBccCWj8F_4RzA5rqs;zc8exP)z@$` z{iFD*hWw3O-lt3F@eLVLZin3S8t+||_ehHC2{iGvFYVSmA@KwT5Sppn+3XaBC zm=2vmVq&Y<``J5#zQ&K^;$b}73F9FFojg-#9hEN{h=W;H_ZqH@6H=|y!@9oQr#%{n zrTOmAdGC-We!yJhWmRH1m&|Z*_9P%fV@n5h*+NYp zqctM%uy(#oc#q6I)pIm0uY;xP1yQBJJVhga1t+VXak+Lg3Q4dUF3uB4?KBr@HfJPU zfm=bQdbOYVC*-J}qJ^P1bFjDf%bo|UnA+RN5YOXZG6D0HYnN_kdUWBi#hOqjJ%_L} z>d{@+r<5;vuF(JLU2Rb%onF&FeoC2eJbvHW$`JMm&b8N`ol{udlFfuVJ240x!8xG_ z7|ORf%jS2~IcssKp>RE4tQ?6vtIFez(JMA% zfuIgipY^Bu=#e(R7Ms-xC~o4TRyp<%Whke=o?mxx`s;_~2`ZyU|6v0kz=qNfIRmtJ zy>LH|ysfaiu1n!ub2$o^q<@esAtvyh6$R5?@oODroMmTPPJDk;W^iFmp0+BIu>_xk zsOg2=Pzd%6xE1&X(xt-ILljf(x=}_|D}E!?(d=VLwo$T&>Vk~v7k|kOL`mWspNg4{ zC5<1@8>Pg1?@N+Da~;miFm@mRoZP=i3Wf`pgcW5DD)LG4;F(Bk>0*nBAa%9BMwRZ{e(gR}2%^!5LVY9yDpUIzWX8eE)ANJR5njo5q+0W? zZpe8{SAHUa+LLY?cc0`FaB9--L~4?};9xZ5bmO(xyZ8E8J6z*7;*y=etOz$$8?5Wf zTXX138f82@Of(ia^8SVN5vUW@Y}jWK`;Ri8fH<>qKP#)VwK{opth%{RJ_RG|vcuF2 zkw?s>+k@U?toho`PJZ&qs2+5SXaSVD>aqtgdMw0+cjRs zoXJ+&f6?fHwGI92aU`(fJA3$a)W?1rm+aOQ^7^tCbHnXCP;FVk*sQis1)V6sk`<3?SUA6r-^sP%CRP%6Jw`e*+U&{OnUcc!A(VsWpJrk&A3F~e3(=dp~2$k_N2MDGXMui~RMO)&bmI;EE9 z<^dfn87`L^P5$$e5|h=D^ZALp();Mh^hE(1({PMBT7caxLE&!f4t2VktaxruvnGSgstpEB~FMtMDotJsg z=`a!_0Se@Ju%Sp-qS>!afcC=$u&QLg&`n05s403$Ts1e!CzQf_sI$lz*;06R=v5i)&} z8pE(GQ?$wM04tfT-;q5Ae0Rx8+{N&`NJtE-Qf#QB#f$c5E<51QOUB#)z@REztQ6T> z9d{_Fs;`wXFaRUofo>}HS6-rJ-B)OR^(xJ|{jCyzy+T~p73FYyVM=z|Gt13W|`r8+!Sx)$2 z_eCqU<|2L4ImVDLDJmLH=V{tIEjbE2K@>8XH=Q*-o9p!kF`4Ur!7*XVfkrGJ1yHl= zhL%lnEBP?xE#258OF>3I1$b;{b30jbqAZP_r5GnhImS|-l+(pka!%+p7Wx15ttsAX zm^i$S`)jGe4j$!elI z4UX$>i2dCmB;ldg>`9~5?B&eK?h>+a#{AV&tfUm6v+u@9+>^;5#&p$DEMQQ#W{Orb zqU-Q<4@d$1Y!(RJzhxT zS(I$Bb?9VRzjQB}hR--#D79K^PH#Wa`(sr1b$bc)r|totHG}(kq7my{YJz{c!^z5x zST6m@DugRBBnl4#tI@)4`Q``zi0qWY*m=QlC1Xy1cY52=>q=yy$?;?|;zn2mNR$8~ zhJGg=(AvvLwFm_cp%nO*?29w~!5nw6kgvU^_MhY~_I@I0&&R)m>hxPD1!bvMT~mk{ zl|nPltx1C??d+syrRQg78$mKP-%#IY9VHQ2>+VIC@9gPGSpYym06=Y9bJ-|rkqn)4 zvGr-ah*r73brXs24&N$I1+&fTjBS@+O7SdN*-p28*Whyj>-hz zd$-pXyWt7Oub{_-_`x6;TtoIvBnR8N5hW>KUW&aEs3iny4-}|9ga@@%?syh~7v{Q^ zMf&Q=9|kStd`8Ij1NKBYg94kp5TwO@TLMshpn211fR{F4z`so-fqX5N`8gd0RV#2hyDsP;0cd zD1e#+FA4k|@6?}gPq^0Kw-}tI0Rdgs`%nxJ>Jhqf(dK146emnhaIIl%|wa4^KbpX0IP7j4d)Nc^~$>+GUTv4Lb zuRYU)6>Yau&Q-z8dpG2+#U})e9z*6V!GEXIKQ&pR8oOVCINuW}2OsHwklUu$4YIhq z=t_7g)Wj1hzhPq6>55^{h`_oup}+q4&S1F)uR09;C2Z=B0C_tpZ@pKsG!BU4Isj_v zNVxHgSf7Wnf3LY7Gm1fj2%we|K78(>FO{W^!uf^tu4k`Aa@#1 zB6bFi`+&K28VPgn-t-QyINTb(<84&F3oeLIOVj~# ziuHAjO+_;d*2ZP&HZgXdkwN_= zVsgdbDu3-H<;`a`#css+n&eLxl<`xz`j&1#dS8UL@Cj5>KbdoYI+sjdDNt3ZHPm_d z+);SlW4P!!BJ;|E8))1oh zsxc%ZSUbYMVF~sP6*YX7NB5>ws%=PdB=-|I`xByiaY!s|XH;D0OKJxb zaFlm-SOGgg^3!>nmK+T>=w9R-u8nR+)jNsa|14cZ{6Qt!B?mZ~d^#Voc%+RNI)(|2 z#!W0z=c?}QA9ebBQLnQDOD#Kfiab5IJK0HZk8)Ewsf%cZWjU9h*FCN3l2`32%7{?K z{m9lhG0ZUh5O;;KOj&L-|7H3XOOhO&SbIAEmxjM@g8`F)lS~1&@Nn?rS~vOkD#V=k zuOIhGblVVCMpfstOlH}aK=Db>D=!O%l}7mZB!sHtUe?x6iER0y8&#?h|Mqu&zhYuT zQqA8AH4Yfs-wXCLvkrLf%D@-kPf6P;6y9P#p*ixuwTD~OxRF>a`R%yO2Sw7NQ4+;WH=<|T z6V=00j?RBW5`gsz@BzMGOEti_TE7m=Ypc*xz9Dc~WqV<(n9J58YF!tl40ukNyF$wa|&Q{)VhNO$=5s~saky7o}N0oqVsc}S^zB*`W&mTR*a^u zvtPGkeOIHrWt!}|^gyqM?s%V_mU(Cdgvgwg9e0Ab?L4I%6@e|6?}|~zE1Gti5}g7M zYvReWFnborT~ZaF%l#10?Fa>&DV?DYvhoQFb#VO&Up_o{AKA0ov;k`YC#Dlq*VIN* zh7s%WQH${xCW6~8KaH@Fq+1@xwc8(Kx@ALr(;uVfVi}J?uaTSQY%X?iLzK+$=&unXcB55|aB-8^@2A7yaK8s<=zvS3+qa2x* zIX2{LHdm&s$35cHe6#Crx2$)u;{MH` z{PJdn9$H(k*Nu!r(n_lvswY(Qdyc6z7iQIYvz8-l`?P>Ki_;5G0?t5`h-;01 zxs-Ht0MR_~lU%M(l#Fr>fAAU@Jm*t@47QuU`Bv?DR;P2X4I;i4yvAzg<`d$-%=mVR zGe;b+ze#=Qp4E>AGkL+q%RJ?QNa<~NDfNi-*leF}(qS`0Aki_fwvweM>iz1!AqldL zT$#CRbtXaJ_zyC2NF+Z=o!Ohi_3bO}40rS|@ri9l&+pU6I2tUTBjq-W{L*USj zF~b#K`%sal&(f|BaD$#HcuvZ3obpD$Kgh1%Glt_`+q?_n+>r0s8;$EDoDhl{vT)uTZOEblGo$AZ%4UhNdwwZmeV`{alh#W{I0 zMB*~GRLvv39x)dI_Jubw2?EDx`46G}O9^L1T~1ZCV%0tih@x5q4;PDmfoJeX0OpsB z=8!8ByYc8Jl6(6#Rwnr+T!=E8A@i>cfs-!n@BSA{hy}MTzkczS z3oXqs5wp|K9<42Jb@bM2Xa`GW=gh4|^J9Z)&I7M!eMX-490v}WJMUNY_yv#b-CL%? zPN{2cXiu%hwA!jk&vTln(o2p0dOgqaz-uC)Hhu6c%o>37@e78B#>`D{m}c*drBHf? zkvkfx`8hYHdQ%bdHG@R2Z(o+k7{Gm}Nqyrz9!>A4soY$m;az07m;T$u%-V^rADHi~ z1xS0(TIp?^d6*Ou*t_dB;pvc^Q=a4@*zPccohj0pvMt9uqi}Bb$mVrwjZHFQ$vpMp za=jN7p*@UjW6u_h6k`C8*^!hDC0FN9{MsuTb3z&W#@28|6y>+7=U!U8Kj-NOYqeZ9 z7YZfGC4tY+A)*xyH_luBg^vZx5Jk>f4RlY-R9@yr_EMsy2xm3h+wnP7FN|XZWLxLUt<@G2o#oXEc)YL?)TJ6tdxHc1=tIHR`U?^ zczl1aS(}{q{Dmz+32)s@CN@MC?xZpm5e7CrdQppcJI_*LUKm|U5MlHxsqD@aBfUg& z?D%oLx(H(r|DIR*I!6#)zN7KnD$`f-kv#6pPoDL29MG~C@QAcT-?WLd#((%RCHCas zIfEt1L19A3V1=4>g>TCmK@(%$6h*X7^M%QsGjlQ4vz(=)_iQ|PsT`57gkSaA!qwGx z5~dv-fzxPvpH-!~7&$wsn?xwylzB3{L0(>FujCI|NUGZU&zUx<-{hy+{ z89q&Nh;m2yGvY5WXYHht1~!Bh9A;827orX$ zncu#S2)!Gp?*K{cl1f57N1y$HK;$p{HZz44od%0eU`mM%BKLY zUV#Gel`f+>fozHHq12NV2m7V@d%px?y2pt=-euL4YlHt-L{P~0`8CHceXvrez7i>+ zXY@76eA7~XC9{2-5I9hC^FS`6zgA(*#~g=^$2G7Ov#g6p*lEC7Xslf8&Jcy70z^Hl zmy3I3uAws~z9nk0B28~c)jnb-TmL47ythcBF7(@VlQOPc|k=kdl@}g_1I#M(w;_wn70(#WF+maBkIIIT|a@zU2Dk#AkR)F;{4Eo1nnMH)5Nq`}>6zU%{IXKh%hzXzG8 zcXu?NqC(g5B)ew@Iv-cPh`oJl4+m8K$CT^bb)mBa(348cS9D{=&Onhrh1kMVx(e0c zPCpH;1(nV8r}ENY+np8FpXd$Z_{GhXJ+qhE$hOR5&q>FSOFAo>eSP~DpoTl>Vos;% zMuYBl#2k&KQY~4eJ8eBKb_J`i*y4ILLg6*j{|_h?Z>yup_`769)zZO%cSqK&~n=nd{ETkF$1G z$VC~v%1(!r6P0&2ZM!|+S0fAm`7%(ipXw)HtQXI4zlO1^3WS9tQUEa#@)S0D0M9EpeQlZDGyUWviX+g5}^6YE?Tn zJ6>dG;L|^r-jpr)iR&7gs4YXDSRcxW4>}vOcGY`@)udNzH*e`N=uQr6woQ>kWkg@P z->n;qpRefBFATp=FzoS-MNa-QGgMIJUSg9!qmis$NgFkpwIiLwE+}q_7kY1Xnxf_} zgz1D(sdg#ZZQz{VYKFgES3r{_10M>@>cZOUhFYEgJ-_dxzzm^9S>>7VOnj9rG|3ww zBs)dub*9^~>WSE|Rx@bd2sQ~_DAS0G|J(@Gx*|Lm1 zkQ`!+<{>h^S`?j^IO?)oeYrVblZIRNDEkc?wzE?O?*KnXYmdPozy2;Of_|rsFU-GP z(NF2^M*5E!j~I^Kpt0A1{}_!p-x@t)p`)F-3xw-FG*4nYBF9WPHHYz5$j}hh`(fLS z#jL~IuV{z>)^q_Q@WIu#2S7>vcLC5xl>|&Degs8ypnF=he)KJd1Pl;30Z0CSE&%sz zYygE{=%lEK{^wa>N$9gWW4eE9{m;W0KY-yI^~ZA?iT~E)0$g