From d04a41fcff1eabee3e18b914776f58f77448f0ff Mon Sep 17 00:00:00 2001 From: AtomicOperation <67163001+AtomicOperation@users.noreply.github.com> Date: Fri, 12 Feb 2021 12:26:08 -0800 Subject: [PATCH] Change to minimal-mistakes theme (#11) Use minimal-mistakes theme. Add a splash front page and a getting started page. --- README.md | 1 + docs/.bundle/config | 2 + docs/.gitignore | 6 + docs/404.html | 25 +++ docs/Gemfile | 3 + docs/_config.yml | 29 ++-- docs/_data/navigation.yml | 21 +++ docs/_layouts/default.html | 49 ------ docs/_pages/getting-started.md | 159 ++++++++++++++++++ docs/{ => _pages}/limited-terms-of-use.md | 1 + docs/{ => _pages}/lint.md | 6 +- docs/{ => _pages}/performance.md | 6 +- docs/{ => _pages}/sandbox.md | 6 +- docs/{ => _pages}/syntax.md | 10 +- docs/{ => _pages}/typecheck.md | 8 +- docs/{ => _pages}/why.md | 5 +- docs/assets/images/create-new-place.png | Bin 0 -> 639120 bytes docs/assets/images/create-script.png | Bin 0 -> 200777 bytes docs/assets/images/error-isfoo.png | Bin 0 -> 29604 bytes .../images/error-ispositive-boolean.png | Bin 0 -> 33288 bytes .../assets/images/error-ispositive-string.png | Bin 0 -> 45683 bytes docs/assets/images/error-ispositive.png | Bin 0 -> 30985 bytes docs/assets/images/example.png | Bin 0 -> 38006 bytes docs/assets/images/luau.png | Bin 0 -> 66811 bytes docs/compatibility.md | 2 +- docs/index.md | 94 ++++++++--- 26 files changed, 337 insertions(+), 96 deletions(-) create mode 100644 docs/.bundle/config create mode 100644 docs/.gitignore create mode 100644 docs/404.html create mode 100644 docs/Gemfile create mode 100644 docs/_data/navigation.yml delete mode 100644 docs/_layouts/default.html create mode 100644 docs/_pages/getting-started.md rename docs/{ => _pages}/limited-terms-of-use.md (99%) rename docs/{ => _pages}/lint.md (99%) rename docs/{ => _pages}/performance.md (99%) rename docs/{ => _pages}/sandbox.md (99%) rename docs/{ => _pages}/syntax.md (98%) rename docs/{ => _pages}/typecheck.md (98%) rename docs/{ => _pages}/why.md (98%) create mode 100644 docs/assets/images/create-new-place.png create mode 100644 docs/assets/images/create-script.png create mode 100644 docs/assets/images/error-isfoo.png create mode 100644 docs/assets/images/error-ispositive-boolean.png create mode 100644 docs/assets/images/error-ispositive-string.png create mode 100644 docs/assets/images/error-ispositive.png create mode 100644 docs/assets/images/example.png create mode 100644 docs/assets/images/luau.png diff --git a/README.md b/README.md index cd54fd6..90ef098 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,4 @@ Luau Luau is a fast, small, safe, gradually typed embeddable scripting language derived from Lua. It is used by Roblox game developers to write game code, as well as by Roblox engineers to implement large parts of the user-facing application code as well as portions of the editor (Roblox Studio) as plugins. This repository hosts documentation for the language as well as satellite materials, and can be viewed at https://roblox.github.io/luau/ + diff --git a/docs/.bundle/config b/docs/.bundle/config new file mode 100644 index 0000000..2369228 --- /dev/null +++ b/docs/.bundle/config @@ -0,0 +1,2 @@ +--- +BUNDLE_PATH: "vendor/bundle" diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a9cc8ab --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,6 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor +Gemfile.lock \ No newline at end of file diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..086a5c9 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,25 @@ +--- +permalink: /404.html +layout: default +--- + + + +
Page not found :(
+The requested page could not be found.
+{{ site.description | default: site.github.project_tagline }}
-ROBLOX, INC.
diff --git a/docs/lint.md b/docs/_pages/lint.md similarity index 99% rename from docs/lint.md rename to docs/_pages/lint.md index 8e71958..78db46d 100644 --- a/docs/lint.md +++ b/docs/_pages/lint.md @@ -1,4 +1,8 @@ -# Linting +--- +permalink: /lint +title: Linting +toc: true +--- Luau comes with a set of linting passes, that help make sure that the code is correct and consistent. Unlike the type checker, that models the behavior of the code thoroughly and points toward type mismatches that are likely to result in runtime errors, the linter is more opinionated and produces warnings that can often be safely ignored, although it's recommended to keep the code clean of the warnings. diff --git a/docs/performance.md b/docs/_pages/performance.md similarity index 99% rename from docs/performance.md rename to docs/_pages/performance.md index 0333e7f..1d25e4c 100644 --- a/docs/performance.md +++ b/docs/_pages/performance.md @@ -1,4 +1,8 @@ -# Performance +--- +permalink: /performance +title: Performance +toc: true +--- One of main goals of Luau is to enable high performance code, with gameplay code being the main use case. This can be viewed as two separate goals: diff --git a/docs/sandbox.md b/docs/_pages/sandbox.md similarity index 99% rename from docs/sandbox.md rename to docs/_pages/sandbox.md index 6b0e7c9..e5d5e4d 100644 --- a/docs/sandbox.md +++ b/docs/_pages/sandbox.md @@ -1,4 +1,8 @@ -# Sandboxing +--- +permalink: /sandbox +title: Sandboxing +toc: true +--- Luau is safe to embed. Broadly speaking, this means that even in the face of untrusted (and in Roblox case, actively malicious) code, the language and the standard library don't allow any unsafe access to the underlying system, and don't have any bugs that allow escaping out of the sandbox (e.g. to gain native code execution through ROP gadgets et al). Additionally, the VM provides extra features to implement isolation of privileged code from unprivileged code and protect one from the other; this is important if the embedding environment (Roblox) decides to expose some APIs that may not be safe to call from untrusted code, for example because they do provide controlled access to the underlying system or risk PII exposure through fingerprinting etc. diff --git a/docs/syntax.md b/docs/_pages/syntax.md similarity index 98% rename from docs/syntax.md rename to docs/_pages/syntax.md index c4cac9a..ce5ab04 100644 --- a/docs/syntax.md +++ b/docs/_pages/syntax.md @@ -1,4 +1,8 @@ -# Syntax +--- +permalink: /syntax +title: Syntax +toc: true +--- Luau uses the baseline [syntax of Lua 5.1](https://www.lua.org/manual/5.1/manual.html#2). For detailed documentation, please refer to the Lua manual, this is an example: @@ -25,7 +29,7 @@ Note that future versions of Lua extend the Lua 5.1 syntax with the following fe - floor division operator (`//`) - `pF)7^r8lz zlYS@p1F7Y@-PL}eR)lOqxP`N$No2C+=W*3#6W$QkK&>*u%V`a^%dIYg=RXP_g>AE> z{8)PRW#>35_nrN-&vPfR4kSi7GCEgIPU&_`0ELzqQ#A&D6|0fTc#ES$x|2U%5b=?N zDuLP#kpR&z7?e(A+&3}APKC-QRFfznc3=Sq$z8k z&SCR|=3HI+OKbM%eU*@BRJp$IM|~rit&Kgqh_s3RWX{dgM%sn-n#>tjvDQ0MvnX${ z>E)vHwJbMoqHu3I?`AB~?!Cj8>zN^H#Z|ohDynxfTgOCd!7|AohGY26E<74V#mKO! zTvUUHGekZpZm9XrXQSaZ X)ja`X(!FMhvZ$2^`+ 6jj9;Fo7y&f+>b8JDi6PEpzg%`pVxUG)WFOk`_!zot?eNj-5-f z3<)s{5z* ovt&8tk;tWtik;N~nhVLdB3DBdqV zWzNzVb1@IPJ@7L5`OO 7 ;yG-#u-0`2Yq-oWzTh_=`r5VypN1856u!rkNm9PZTUcx9 zi4$fQ7F=X@_aS9K?otV!d^CQIEap}cNH(Z=I~2f8pt bi6#_w{(U zAqcO+EH^OF@1hnd3brlXCd$uA&pa$$`_{9*n4XyaRfJM-5S^bEnTj_?T^!v~r)YuT zrgwU7W-C|djIQ`{BLi`bT%hX5Q1UZZrM *$oRfOjc;RK<_&C& z>2QXL@^>vqSO~k8&IyKtcKNz#8JIHX!{(y0K-q1=vYN~U;h^D{`Wk-U=bcRYmzt8# z&TLRz)emR&y6Tx9g%!LGpR-BNRqVk*AoLg8&^SYWkw;N7prq(^y2?bM%N1mM+aIRC z?6uVyTxWNPcCoJ8!4(cC`f!`*b?@ooc!ku}h0Mhon&@HaO>~eh%PC>EsEYxmbSNJB zT eb)TS =sFuJu5oVeRy&_cq0EO&Pm4ExzusR6*`C zJ3Dy|;*_a1CAQy=yJJu_A5S@1H&$S!tEV7HVrfn`Y)q?Qnu=s(pGr(@(JWxC;9OLb zx|k9#OC*G;>#y{An-@q8#iZUj5T2M5U-r&iB2rvVm(ViL5N}+Z!bGQZ5I`u8$7)o+ zh*_RznZEfkJFV)Nr)st(*Tc*l<)%L*7xleH-Hp>Xo!KeUwx!XpX^m8_sP}D}=dsMk zW;G7g@9=a0ZziB?7gx8QYo3G|(A^{+tDmQ0tCOQybv!P8;;Dt2 _iEIP-|{IXCI>SSDcFO?RDdcwksin47{ok+MZ}#buCgsubR?Zb<@eBxF=Sh8mnt# z+CA0rZp8PL m$P1-@V>B>s$@h8(1tn0k@*L9k!$G70lTyb+%-LTYM z!PZ?Ib>3~i8Vov<4O7}a83IJ+$w}sbN*|7llShzR-YIobQK!< yeF^9Q*gJ2&4bKCY!Xr>2}IbV(g+ zR!Djm?RO!WEfnXZxW`$QJy)#;%S3gEnmcIz{&F43pZhW>S-%cl@c4auQEKjJ9;N3Y zX_r(#Ujy9iMm@*`bDo0%z`b5!5>cIc%kI^_rz%hDjwg0vV%~9FD2Aw|*DY>23go6s zx7Gc4I(g)wTzb{7mig-Z&9!rvkRqA#*M-$kBhX^-v4e!J05GhXRt(-=P*m(mD
(9#|bZGGB-=M`)XXD&FRitCJBkm9ee{QRb|K%P!S4$@h>M;e6Z(iRadxe&@v_S zeK3ZOntA!)__~`+yNoYdy+S}slR@w~-_r;*5Vu!zHI0sY!gm!X@8twO)Asw!cu^S{ zP&<^E(w6}^ais?l0aVb{-YeqqQ6tFd@LRH2t;)n%DNT56Z+;LNPh~TiGp*~6oV%R% zJw5qa2t^zW5rN+H!)5~~aq^kCfipe$ox#!1*lRi*Z(G~j-5a`xc#8X~BOu<`ps8g| zz@&50P~L?4S-1jw;tzo37(ap^ps;f;4gokGfD7=u?({vUOGhZ+OxuZnIx^~hfA0q& zjN$k(l%7`aYa3bbb5q`@ATOVQx?i%?e)-rPEY}rB|CCt7QCW%_8wrXU@bwVxGP)Ix zX$TiyxTeIFh@w8?P3h6);YPrk9M|4k6ftV9OxIWP?<2mSVy`I_jAqikk^dg4t-y&( zWEx_Ctu5C|QD{#qyeVxYF>Ng&oVse6=e-Q#op{pmIU7=;20oPV#MNQdD??B5o_Z9M zl4dA`Dq#7tl`qc83+Xfd2@>(}(~E5qu=(Jr{Fz#a1#k2C0i=4erYLzSh5T+3j7ES5 zkFXsG*M9N2Co&-Vkpipt%94~YQ1N?08o47|CN6c83*SPh5f1L%#$eOUSCSv8_Kfaw zGZI7JYkKT+XU6c60zRV^PQTOA;6XuDd}8X_=16PqoZPpJ=zY#RTwb!}U0pt)a#r55 z8>?gNd2eDX_9Z)66nEJ>oReM7> 9#iPr)R&?ZT3#aIWU8JJ|RBE zWa5~M9}!#d{(gR&r&uSoS{mT8sex%8$q?^OX@Wk*?IIeM%3(AVK}90^;z+30+537k zpSlrww{)&v@4B5 O5envP7qIZy_$?Lif)VHuyqe M&HcCXnW}+vV^k zTza28_VRuDBpqap=U0^uVp_E)*7APAnH-#vFjtD@<-;N@5V$lW1(=h2A`bPSzte-i ztKoB_`GgeUOuh1YNOoO8merM~9%YP!)7WS6VFBZS%3Z<>rCoJ~6s?BGoyOG6Oxo9@ zI^ {&Qv* fGDnnB2HKSJcaNBg9yRg4aDEGWduRA0dPY?CH#RUD`A7 z2*P+^t_+}C!AQE)_c$S^B!Y|Xin1jxbx&&%uj-b0`v=IIo*-G`SjpUp*6BVk0dmu^ zXiSwY{yoTeH#djXAg1z{G@?KeAZBafmX%UZ-jTAf{Ss?ZTDp|l1oK|7^qjeO7cWZg zH>osqmz&pKt^&Q 1-v~(ooDQ~>NIOQpe5PwqInYWES7HQ zeSJa1c0nfsLaSIu45#DLchW|_a}7I#M(R2903~Coy~=|djk<`?>9@Sp3pc`wTW6X3 zLqt64zHFf&JJBM8&!Rw6B;x+4iNeI^jTY*TuiXc9qwEAnI#@B!c$1$31P@-f0NCgC z`CKn#GwwS9)%NC%Aqdzq7vT@7ssg@7@VCon^~Tvd-(bsud{&8aKNwJTP+a+@nwval z>;YX1<;)Fo6n&s$w091 N`B8GY`oPwsh>zC3S4mgQsm-hmz%ax8*)mB)0)qY?hwaS+5`0 zWOEsi(a;kYioC>5rF4KtZ#ey-`0P2kgLzl*rk*vliQT~@B2DP6(28N_5biYjG@>Hm z7w8*o1PMyth4=ilV;iWZUz~EWHZyu39dqptAJds7JuV{Q%We!bKdrK{n5v$aXG!Lg z_Jr7mXqGK3-^J^jmoMtoy&Duyri_y@q~GOG0?~{t&1@u;^RT;Hyn8Hg%jg)*8Q80? zy?#Z#b)V8I*f&QUeOR`lXUrf8ii(E%g2r_MUGTu1uvI=cSi%@0?MQX$S$Dfmj$hdr z4-H)9pX!6!Jo+hKuYt14y1dLkZ<}E2@yUs@bur+FzN<2?O%}^c6+69~qik(S$WXKM z$;-i1bunSjW)D#sz4++(0w8#2$V3*O46yu$*2DlQuV$~eMPl;P&~9sbHL;aVoS?-s zkYAeC*4RG3I#sH^uCc0ytxkmgP0n38uTuUxOdoPK2X1B%0-)YmvL1x;7!5q_!* )~Fsf7YtRdN`e+o5CBes9tcV|)PF(aEHO zCb=c1Xt+9ltJzSa78>!|d$G0Se%L(W=LK{Ou0x-LXjVVfuWFB_b#B`%0P<_0d7IX+ zd=%nA0Gy-t_qIMXtfCXm!<>0h1`eZW$?ct5wT?U9-o(R@p~UtRa2rPknBN7xj^gI( zKzV{Nom7Y5>A(vNqJV=Ga}lm2?m;(mYe}SZvAt0Z1rdRT^+4sQfyy(wO#y~C^}y~Z z{rUcx2PHBQV}#q~H$yYKm$0>3mpA%Ih{jYSa`xcs%($Jp9P)O=l>(CB!s|@mSSgXl zqQn6jwM1Ja)N&5IoU%7ViPR$Ga@BxTI~fm|^AwDd z67{fVQ$)ucJwk1T3?Gf%c^56bHlign@NyMo_DNc*4gT^TGWFEU2yxIauFd<~=RpO+ z=_!ea${?I-Po<_jS&{P(umLC9pW1p3oA-6nYL3`?xt8BacoJ{g7vF4}ky#(3{;Kxd zwdkYEDF>TAaEV IP&eS3&re@>ivwl!Bqw9aj_x*rnLcKc>7<@Y_aZ8U zk@4Tg-fjv{+j*K_8}u(?xlJ4a?m?ONX1y%u8cQtKm=yA`Iko p i6@W`lY<#odH?R~mr*;`*3 z=!X(Q uOx19_W z&b|T`n$H487hD&0h_&-eH(<)lYs*ehlm_(zmFf&!z`Y{nMzG2Q&y%SDv3jJ^?M!Fq zow4!8m$&|Vg{?KbVuBtl;9f30;e7!bwI9%{^5ZRiu8KrIUw(Z%5!jrTQWuNB4k)hM z@~bNJ{<#;W%RseWwUM&Js4*sZLLOQnf1gGtT$=)Ww-}r^`i3{%hBo7!iipNa9(_MJ zIYzkYvNGveD$RUHweZ7+F?5HxPjQQt^AUg_%%pGr=&qmEMGNWR8&;nyp6F(+G3#JS zZYFDvb&X`2EFkR_YdNTxvb8!n_@E$kXX9e@D_t?}8!HrFOFrL*5H~$7WFAa{YA{o$ z#U|C-@U_S}zHq8M^`oMkbi0O+_k0qO!-C+cMo2puq}F)jeDsV2+@%