From d3f63a9a4e558d665b28997d7462b8c443607da1 Mon Sep 17 00:00:00 2001 From: Dominique Schuppli Date: Sat, 28 Aug 2021 19:30:28 +0200 Subject: [PATCH] Create basic setup for Jekyll-based website (#1208) This Jekyll setup is intentionally simple and theme-less. Templating and front matter is kept out of the actual Markdown content files as much as possible such that those files can also be read directly on GitHub. The SCSS utilities under `_sass/utility/` mostly make use of class names employed by Tailwind CSS. --- docs/Gemfile | 3 + docs/Gemfile.lock | 69 +++++++++++++++ docs/_config.yml | 14 +++ docs/_includes/head.html | 11 +++ docs/_includes/header.html | 13 +++ docs/_layouts/default.html | 10 +++ docs/_layouts/homepage.html | 10 +++ docs/_sass/reset.scss | 34 +++++++ docs/_sass/utility/flex.scss | 21 +++++ docs/_sass/utility/height.scss | 18 ++++ docs/_sass/utility/margin.scss | 9 ++ docs/_sass/utility/max-width.scss | 3 + docs/_sass/utility/padding.scss | 7 ++ docs/_sass/utility/position.scss | 15 ++++ docs/_sass/utility/space-between.scss | 18 ++++ docs/_sass/utility/text-alignment.scss | 3 + docs/_sass/utility/width.scss | 14 +++ docs/assets/images/github-32.png | Bin 0 -> 1714 bytes docs/assets/images/moq-icon.png | Bin 0 -> 6829 bytes docs/assets/main.scss | 118 +++++++++++++++++++++++++ docs/index.md | 8 ++ docs/user-guide/index.md | 6 ++ 22 files changed, 404 insertions(+) create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_config.yml create mode 100644 docs/_includes/head.html create mode 100644 docs/_includes/header.html create mode 100644 docs/_layouts/default.html create mode 100644 docs/_layouts/homepage.html create mode 100644 docs/_sass/reset.scss create mode 100644 docs/_sass/utility/flex.scss create mode 100644 docs/_sass/utility/height.scss create mode 100644 docs/_sass/utility/margin.scss create mode 100644 docs/_sass/utility/max-width.scss create mode 100644 docs/_sass/utility/padding.scss create mode 100644 docs/_sass/utility/position.scss create mode 100644 docs/_sass/utility/space-between.scss create mode 100644 docs/_sass/utility/text-alignment.scss create mode 100644 docs/_sass/utility/width.scss create mode 100644 docs/assets/images/github-32.png create mode 100644 docs/assets/images/moq-icon.png create mode 100644 docs/assets/main.scss create mode 100644 docs/index.md create mode 100644 docs/user-guide/index.md diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..a1ada559a --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' + +gem 'jekyll-relative-links' diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 000000000..cb3caffeb --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,69 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) + colorator (1.1.0) + concurrent-ruby (1.1.9) + em-websocket (0.5.2) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + eventmachine (1.2.7) + ffi (1.15.3) + forwardable-extended (2.6.0) + http_parser.rb (0.6.0) + i18n (1.8.10) + concurrent-ruby (~> 1.0) + jekyll (4.2.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (~> 2.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (~> 0.4.0) + pathutil (~> 0.9) + rouge (~> 3.0) + safe_yaml (~> 1.0) + terminal-table (~> 2.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-sass-converter (2.1.0) + sassc (> 2.0.1, < 3.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.3.1) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.7.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.6) + rb-fsevent (0.11.0) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (3.26.0) + safe_yaml (1.0.5) + sassc (2.4.0) + ffi (~> 1.9) + terminal-table (2.0.0) + unicode-display_width (~> 1.1, >= 1.1.1) + unicode-display_width (1.7.0) + +PLATFORMS + x86_64-linux-musl + +DEPENDENCIES + jekyll-relative-links + +BUNDLED WITH + 2.2.2 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..79567049e --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,14 @@ +baseurl: /moq4 + +defaults: + - scope: + path: "" + values: + layout: "default" + - scope: + path: "index.md" + values: + layout: "homepage" + +plugins: + - jekyll-relative-links diff --git a/docs/_includes/head.html b/docs/_includes/head.html new file mode 100644 index 000000000..392a9cdcd --- /dev/null +++ b/docs/_includes/head.html @@ -0,0 +1,11 @@ + + + + + {{ page.title }} + + + + + + diff --git a/docs/_includes/header.html b/docs/_includes/header.html new file mode 100644 index 000000000..352f618d3 --- /dev/null +++ b/docs/_includes/header.html @@ -0,0 +1,13 @@ +
+
+ + + Home + + User Guide + + GitHub + + +
+
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 000000000..bd77f1c7a --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,10 @@ + + + {% include head.html %} + + {% include header.html %} +
+ {{ content }} +
+ + diff --git a/docs/_layouts/homepage.html b/docs/_layouts/homepage.html new file mode 100644 index 000000000..213bece8a --- /dev/null +++ b/docs/_layouts/homepage.html @@ -0,0 +1,10 @@ + + + {% include head.html %} + + {% include header.html %} +
+ {{ content }} +
+ + diff --git a/docs/_sass/reset.scss b/docs/_sass/reset.scss new file mode 100644 index 000000000..3fc99e8d2 --- /dev/null +++ b/docs/_sass/reset.scss @@ -0,0 +1,34 @@ +*, +*::before, +*::after { + box-sizing: border-box; +} + +footer, +header, +main { + display: block; +} + +blockquote, +body, +figure, +h1, +h2, +h3, +h4, +img, +p, +pre { + margin: 0; + padding: 0; +} + +:root, +body { + min-height: 100%; +} + +img { + display: inline-block; +} diff --git a/docs/_sass/utility/flex.scss b/docs/_sass/utility/flex.scss new file mode 100644 index 000000000..ecffc578d --- /dev/null +++ b/docs/_sass/utility/flex.scss @@ -0,0 +1,21 @@ +.flex { + display: flex; + + &-grow { + flex-grow: 1; + } +} + +.items { + + &-center { + align-items: center; + } +} + +.justify { + + &-stretch { + justify-content: stretch; + } +} diff --git a/docs/_sass/utility/height.scss b/docs/_sass/utility/height.scss new file mode 100644 index 000000000..9c7969753 --- /dev/null +++ b/docs/_sass/utility/height.scss @@ -0,0 +1,18 @@ +.h { + + &-full { + height: 100%; + } + + &-24 { + height: 24px; + } + + &-42 { + height: 42px; + } + + &-64 { + height: 64px; + } +} diff --git a/docs/_sass/utility/margin.scss b/docs/_sass/utility/margin.scss new file mode 100644 index 000000000..b4af37475 --- /dev/null +++ b/docs/_sass/utility/margin.scss @@ -0,0 +1,9 @@ +.mx-auto { + margin-left: auto; + margin-right: auto; +} + +.my-36 { + margin-top: 36px; + margin-bottom: 36px; +} diff --git a/docs/_sass/utility/max-width.scss b/docs/_sass/utility/max-width.scss new file mode 100644 index 000000000..62977dd4c --- /dev/null +++ b/docs/_sass/utility/max-width.scss @@ -0,0 +1,3 @@ +.max-w-650 { + max-width: 650px; +} diff --git a/docs/_sass/utility/padding.scss b/docs/_sass/utility/padding.scss new file mode 100644 index 000000000..4ebe8c550 --- /dev/null +++ b/docs/_sass/utility/padding.scss @@ -0,0 +1,7 @@ +.p { + + &x-8 { + padding-left: 4px; + padding-right: 4px; + } +} diff --git a/docs/_sass/utility/position.scss b/docs/_sass/utility/position.scss new file mode 100644 index 000000000..89ffe77a8 --- /dev/null +++ b/docs/_sass/utility/position.scss @@ -0,0 +1,15 @@ +.absolute { + position: absolute; +} + +.relative { + position: relative; +} + +.sticky { + position: sticky; +} + +.top-0 { + top: 0; +} diff --git a/docs/_sass/utility/space-between.scss b/docs/_sass/utility/space-between.scss new file mode 100644 index 000000000..15ff1240e --- /dev/null +++ b/docs/_sass/utility/space-between.scss @@ -0,0 +1,18 @@ +.space-x { + + &-4 > * + * { + margin-left: 4px; + } + + &-8 > * + * { + margin-left: 8px; + } + + &-12 > * + * { + margin-left: 12px; + } + + &-16 > * + * { + margin-left: 16px; + } +} diff --git a/docs/_sass/utility/text-alignment.scss b/docs/_sass/utility/text-alignment.scss new file mode 100644 index 000000000..7150ea400 --- /dev/null +++ b/docs/_sass/utility/text-alignment.scss @@ -0,0 +1,3 @@ +.text-center { + text-align: center; +} diff --git a/docs/_sass/utility/width.scss b/docs/_sass/utility/width.scss new file mode 100644 index 000000000..684ee4e1a --- /dev/null +++ b/docs/_sass/utility/width.scss @@ -0,0 +1,14 @@ +.w { + + &-full { + width: 100%; + } + + &-24 { + width: 24px; + } + + &-42 { + width: 42px; + } +} diff --git a/docs/assets/images/github-32.png b/docs/assets/images/github-32.png new file mode 100644 index 0000000000000000000000000000000000000000..8b25551a97921681334176ee143b41510a117d86 GIT binary patch literal 1714 zcmaJ?X;2eq7*4oFu!ne{XxAht2qc?8LXr|_LPCfTpaBK7K$c{I0Ld=NLIOeuC;@2) zZ$K%a)k+m-s0>xHmKxL%0V&0TRzzznhgyqrIC$F)0{WwLXLrBvd*^wc_uSc%h%m9E z{W5z3f#4_!7RvAyFh6!S_*<8qJ%KOIm?#E|L=rJQq=gB5C6WLG5;c?r%V0>EmEH#X z5eSwPRa6WXBMs#$5H%GtW2go-in9p>zW@UYDNNWc^XOXZQ? z1QjEV00I#$3^1wQUJ8&-2UsjB-G|9y(LDhMNN3PM{APL4eYi{(m*ERcUnJa{R+-3^ z34^A6;U^v`8N*O6ji%S@sd{fJqD`XFIUJ5zgTe5^5nj414F(y!G&=H(f)Lgzv?>%+ zAsWD}2qhpH7>|TU`X&W6IxDNuO_vET7|j5oG&&VDr!)hUO8+0KR?nh!m<)a!?|%yG zqOwq!CWCcIhE{<$E|F|@g>nP6FoYr6C<8>D?ID9%&5J(4oSbR1I^byW*g@__U z4QsF&uJSEcFeleM3~ChjEQGbHOjsGDMbyAl(p=Ttv9RaVo8~I#js@@Y9C^_2U})yn zzSHU%6FxuY?d;&65MyR({^lU*3$z$ZllDb(o&<7d;A_`h2U+3~BJ2Hv`{W}KEU801#cv_B|9Cm!ynR{S`AMsSn z;7E=B;mb!wx$L;S>yGXG^6=&WlQn9$s?&L%Y1D8TI^MlKB1DqsEng$>f4=xYWBoPI z_S1p!sJ#d2?YI4kPA{k}Eby?F=f-J9zIc`YDl^pzjVm~9ebE?Hn?t0Nx+la|D0MB; z9)2xv1G>a1|A9kQ>~DV<=X3-4yC&n!m8-3K#P z{X@0zRuQsy$+N ziSCoLJU{Z$nQy4A4Y5UJ07$5FA~qL2%Q+cLaqDU?Lz3?=BC5;Nk6BbTmmceEaM>-Z zi>O&-dSE=%ex;vcvCOk{*JQ5^_4M z4lW7%l9IqY(z7pV(?I@@8=KPFO82)O{VDI18-*d-k$YmI^XiuPs_LuFw<^ZcD}yP5 c*NrbeloN*74g`U%%F6r~k%+>C^#XapzmV0H-2eap literal 0 HcmV?d00001 diff --git a/docs/assets/images/moq-icon.png b/docs/assets/images/moq-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..41cf4062f3028f6aed379ac62d7cc65b2c14b25a GIT binary patch literal 6829 zcmV;e8dBwnP)wD^r8n*D!76n71)>!Pfy>+kUh$H0OK1B;3Z zV!$ORNkBnCRAi7vBq$jP&M?EwFw_5e)vvJ`W_qf+tLjzv-0z%wV7jYb-RioxUcNUI z!3*jF9kgTvt$;Q_WBq*-paF20mij;rkOfo#`+B2(F--M-KyE>*h@=$P8ep!I~~(2G#dKAdCaRyCP&2nEYs6mBFD95-W z#rhOp%XIxR5mK0Tz(aaO$F#vEt9%aJ3FMi6n1XvW2VM$*aiy9J2V|l-iRlVF59|qm zF{P?(10Drhn10xTeVWKw_7jY)4ra#5B z@uV_2!1w?>XpzL^ZqtU8ikt;}6@Z5;;*R`R`X=siUjQDci2Je=xY)FDB{N3>Zw25% zig+te>b>}a1C(>D3&6t@@khP^nwmDcWZ_1jAOH_d#9#SA@AnsC@L&KQl!#fm%(M|k zlVMr`O=Jjnm}x}>;|$RDFkf#0uJz=}5UxlSGS;+V5`Y@yaNvF5G{brb!Q*5db8ME5 z9%%%VVSifdzyL=W)IkV7(}9b0t>QbTHn_Ccp)tidgqrB1*KrxK6%#dxa*m}sXtN;L zWuXq_=WEB^?;51F?sJH92u?Xu_eXr4Q1r6~Ib6r0l4g~V2p{O7U|;ZS6e~~H91^8Z zNR(ss=+-np;t2cUAUVJS8Ojx0q>GMBKi%sK`QaerfeU=Nj!?TeUC)m!Fs(=;$l59q zuVtWVBafFG1MuUCq`qtgPV~x%y&Ah-U1S-L3#k6CUCwW_`yb? zO}tCv6RAO7(-#(mAaj^r-4RzmIo=xNPddGpAS4St{R2<6J>7g|ge% zot_lWMBy-}APeOQ%)Gz6~kUZ3hoOG`T-(Vsajqw@cqmf;oA`c&34Xu8%Ss_b)TR`FRM z?{%pfWfb-6*XP`G&!tC?9(3x|i3SZCSl?~gvW0~U7xKXeAFy`qT0)^i=XTWjUAuOr zfB*iRbka#QYu1eN@^XIp$rPgJSwt^_m)MqKVb3S1$$+9!#G;eJrO?231kc&A-gx5;>u=>$x7>0I*Ijp=4zAU`b@EH+cu_6o5t9&V_Cd-vFG=d zk&(g4C!fr~fdlE?yEn%le>~aQ*@xU;w4O?L^?gxMk#(;hfBZ3%Cr@Ve>R>F1tD6I7 zbcPvH>}?Z`D@|Je3-iow(JP3v)lrVtLdQc{0vv0 zm6a75HEL9-tgI|lQBe`HOL=*DC_g_xG;!j@(9b{r?D*W$($di1{`R*}dV0Di_m!5G z7HZe7U1;{~*_LkVn(?B}-?wjH=!F+v2sLWd$ST`JYJu!5Lib%uXyb>3islgdbrzw5 zS%eB_#};+Wub&XwJDbq%j|si;PeScl5=t|lDxtE>t?UeyYmnB!dRKii201x7y!`UZ zTzTb{2j1|0qTb-oKmR;KhYoeM3DdA)LmqtaL52(&LfyJ`T`O1VxPJY59(m*u#*ZIw z)t-K!YK&Vif!hbc5slUF_FGNil*rG#uN2;y4Npvfb(>vPH&L2Jr*f;jC;cwqY`-*7 z%^cM%GT|KPW}9mM6c-m;{TnyRJK=;AtY*=9=bcAZmManX4=P_dU%!6+tiFtDDtb+) zHZW^6Typkr{fk7#57fCzvNEAdd${I8So9tIyv;S06J;r|BJxLN2YCuO!VfJjyzoLs zjvQ&sIU*>d>)Ep>Q>RX~1_Bacz<>d~`R1FnXwkycQK*PxckI}anKNe|=*YW?>U3Yz z2VNN-t~I>49aUyd7F>M+{PHU-Tjl;W;y|^aK92km?I4YTQGRKmoI^d}APi?lI>w2- zk(F~ynKFgEygXNRs}A+M9e3PuR*m9zO`@L2kb&^@T~IgM8|OH1tu*!f!-c28x-GDL zjd$0wNii@!@<;To_tOy*Jx4VU)~#D-jXnj14I4Jlu3fvh+V#gCdn})P@(C?lw)8}| zSg6|L=9_P3!h{K~m8oiuXZ{j?yZeReo2b6cpy4pn`@zLn6zT2dR@9T|_DyHMG`RTU zi>cQLBJq%wmBsMk!xL_zo-gX3(u$H*2Q)@y8#xty`x~og5jNI`)n`?r=QN zpzd8Yjb_c7#lsIjY)x|BbI(22(CxNu+Z?|PlpdE~emQO1CYI>ystcfd7w66qaVX_r zAw8p@{+|{#tm}l!dx!NfNUz9$B0oiaC-F)XW%=^u){JsZ#;BSus`DF}S?=1kD_?&d zJGf&(K>eQic-@c3(F~a(dobdMBZ(BOWLvCI8W&$*CXx~B9&$PcBW-NmD=EFCu z;TIigs(GXEFzz3F!bN&htCMoyod-Ak)98%5YUq_jTAIGa+f_zjcYa{w#*GL4y>;tW zs}r4>S$zXp8Q`v6yAJ$aR#s-6cl6Om$8<>b*3QYvv87jp+ittfI?qWBa?Lf@SdL$n z6ROXOi;I~wX_8gD%$qll&YkUd4F?V!$dN}LdC2c(2ld8o(InhawnL;-eZ_;}PPJZc zb%1TVV8vRPI1_qygNcuXozRYxsAH5<<<*B@_d326x9FhW<&h_Qt}!(n;?=OQ({c|# z{BXK=?{3>Ul%w8o!wuGA%bIE^_5IGBJFWSdZ@&4)woVxt8P+0Cr>HyceM-1Cu!B;6 z>n=EF=x-xVRoziYFHrn+8T7vw3XAPGxl~8}>M9qY`-b&qiacFk`X8x;>aQq+w9EAA z(|PT+*Bo6#)r5~d_L%KHi8}72lTLE}5=nz@9qh-URqupH$EDk zfV4xos-4WHhqZNd9Ts-{Zi*bh#*u;<8(>RDG1flR2)PQs;9X)h#*u?Q<*3fgz9M| zqgaAaJ@u4>_!!(p5R!@< z+)t{ImX_vde@9MEjuinhUYtZ*DJv^;Tz*B!+5Qf@`^u}u!L>qWI{-VCgZye#g(PL~ z-o3W>d1Pj0TH$!&#YuduqM{XfDp9E27koW{){JH$ca zKsB#6ZQ5izAaS4!e)a0rw)-KY=+PL~HmtK0Q?I`#a6%~&5uSeKd8g>$U*ML7? z5w1y`qVE2JQ|(7jDJ+7m&i&m@tQy2z?7Ado`SRuL*|W#?@qhTkAGqnJn;g|5xw*MK z^w2}L&ry!Ja^*_Lj;M-Xy}^F8k@l^j-&u|>VR3dhIK8t?2LZlaW4wvAE4^~sTfrVB zB_&oiDJRA_cI;TLzyA6f4PJfUp+g7e%$egTAhoJNKK=Al+s7Xu1PhnjKfIzG{xuld zw6K59iO0f!M%ZtfWu(I!Gwhe|5k<;D63aW5BE-}D898#Kqe$%8+1b4K;){$PJ=)3) zr5qt5>g^x-w_m@0RxB(h`AU@jOO`CL9RdHKbAf4}gWZ5A%D-DShs7_!DV<{12;)9V-b>_wL;tM|DTn9uGY5K-}{)`D6IYZ}mFz_6>^1R=YciKVS!hb)5V)HX}-zo>$Zd!|EX4I%r^zYx_abA&T&6;t^ zC6`zRt!j-(O%!iZQ{`;4XU~r7Ty!klzdQ|}zi591H{v9J>H{}i6b{kztDaRmtbVv= zDlc~)WG*8E#(iis^+AMn>S@^TX$ps+40FtwF>#$6X;PsbBVOlF{h<*fMkGADpZ_Dg zH_!PHZhBgH9z{8Wau_Ab;o{Aw{=t0s+(DnnBT6DO>A^_8o1`eCyz|aG`Rc2$j9q{D z@Zs@w&MTJ%JUlM^Z@j+dq$yPu+jhe(kA)q~FqU5^2iag+lOT{t^uzMXL|1>k@8=BA0Bxn5FPUfRx-?p zgE(KG5GU$^+Ffy4IgPWORLNC+Us_soG7Hr~P9y?*gar#0Sjk4GPMvBwiJJzj%9=la zJ{>!Dv?d+Bq^JaLeFDZ$^Yk)S&GGL^aL+UT)>t;M<_9AVGS$y3zxUpI*27i?RF$aj zlu<|L^Hcw-=F7&78>=-sb*_4QSMEnUfPG-;A623=HC#ATOVW~FAHJ$rUS zjuO#(?%cUtef8CxfByMw+2YUKZbb<0dK!j54|^Tt7qo*atGER29S!%7f%0HEhr$|l ziC9u5;Cv%N0t^{4gfq@Kqsq>)GKk5OCtD6uncls7^XQ|GT1hmc&sFEFTer??c2t!r z`lg$1vib;BT~8U|M<0E}TW`JP%DqKU*HUG7>C%N^!-iQ7lbf4+;BzVs4n%(z$#^?) z;zXW(_E|^CJl!Tu=P;b|xL)d>C?Qz69tJ%C>w>$EBSV>0w6!RY>E@>fu||%(Xj}Vz zz3A(z^0TwEt+dXaI(4E|t5#MTw+0OwSZT49gBKJOuzmY>HgDccety2?6v|1W9m*uR zbz#V*F!+yfM4Tbdf7}=z0C?r2aIF+jRKxNjDs6jt8yI9xr`kirQL8fgSl@0Zh zuW-4;)UT=|{`cp?{hNUE58z><`XGvh=Jcsu#2Rd{GZ0~#(lQt}3N~)H*Dq1We32jS z&m@6!C?-b!6YU@?&FCT|BdU4y^=kXG=Bs}S)DUhg_C&8PiFT0B%;+N|Bi2Gh2czN{ zb~D?W=O90bc923~rvLf~$x4BPPIlwGxZ*sR;GnKX<>jM?j;jhnHEh^w?>N;AJH8!c z#IcXv0866(sO%u){nbTCW|pn8A0w+(Gw9{(BtqOAv@E)^gA@RZ{nbZER=!*b#Wk#JhU&?g6UWp_BN=0-;v0V-KwU+1}`sYG$?l9o%(QV*5or=0BA` zsA_CMInAH^(ML#jj%)_qyV&2yeoCkCPQ$PN2W39*IjMnN!2hY7?VzgL%F^2ngX`x) zVCdKezIxU9-t*;a;2$r+?4?i^jQj%c0hd(%u&NqFc~EoU6o2#*l9?U5;pi67rJb|$ znm2;0E(k|FDJX((ecNzREl&c=Dt}m=&mRS>^Ij(*709gz%O^myhR)9og&;EvPP`6Q znzguQ%HJ!0SX~&6^}v_j>m;NCg+(yp#rV#RG|L+1xvG*=-ml6zh~XfL$=>NBq#EO= z!Gr`hZX53KK2qHmu^i+>Z*&n-m0_b``l7&Xovn!#z|!izjO8HtfcfyjLefyWA8vRA zmaR6ei6h>K^<_<={2p~z7a`RtEQSm33^%z{{~`%$lXqi%S(Ae-02aBckC5sVm%z{` z;hty10q6qkB&wesGaSC1RrWJ_j-(Tx{HmMnQUi@}P*M`R$ z3KImo)XfRkCas!>LkR6FfjM8nPX9Ay4y>vFfddE01UBi}MnP}|tEm+-vR8dQ(6;iz z#Hz5nQ&<($0O*;xZh~N(EA58cbuxk3Lf0aKkjyLqde}YKNvw%NU6Y&>pI(9x2<~zc z;>zg~m~_3$x0Q3f1i?5ffG#-b_Bf4J6w)H|B0{oJ0`vtoJ2@$yMU>gV8lYty=L&); zUIuP`d+OP@O3tZqrS%Tme*GDJ92?GC(nn)B8F)7cuWz=p) zTj{8?^E7g?OhItULft2JC7`LB6Mf$U*Sc7qAjHEkx10l)`XJG)2J(RJE|)6^HK97= zR{*n2D^e3#z&8PChlIn_xjI9dt9Tg_wR`1^p@QH6 z>wr#xCoxgHT#fsgjyqK1;WdQX&0gRtubcx9I_Z_k*NYh?*n{8&eZ9`9>9vC>=Ie}A zC;MkhTL!3n7yC@Ff9N-u1Ipr6Q&K>OVadKUDH3ZNOH=n zrVZE+j?lroO#j#-$t5qC&(!80=~9!3IFMIslXFC9syEV`{_#bEEh*jSu!D?liBu;k zIa=kEy1-Kbco-tVk|CxI6Q3puYhphzT`x&F&$KdvarWvN@|2ncbc=z&)&RV{M9j!q z;B?bQ7<5hqehI+C67g5Q1nQVJzGR^(Ff{-VO~iXC*PEU4OdDOYkp?^zfCnhztqd}4 zXvxk19W2}QgA{RB7U<@*-~u@kcPpjj8J#&4z=iOkRM+g{wWk}eld(Ps_pxKfo%aWpj4H0 zk~k^(X#m`+vz?kYs8o=0-QT-ZhHX=ip1|h;FtTKoNz(aFebRJb?I(49MbkzXbWt7e zzv~QQLM^194zz9B5Q8RDWJF4crUP&XFhjSqO&h4+vJ-e$uTW@g`e6vcCL6dJm=gfQ z^;#wam&oecs*!Q)nrQ;`22KIG0cQa9Oe+;9dvtShpd;oBc zc9MtQ^8Eh* b00960reLzkUBjK-00000NkvXXu0mjfsqI4` literal 0 HcmV?d00001 diff --git a/docs/assets/main.scss b/docs/assets/main.scss new file mode 100644 index 000000000..a1821322e --- /dev/null +++ b/docs/assets/main.scss @@ -0,0 +1,118 @@ +--- +--- + +@import + "reset", + "utility/flex", + "utility/height", + "utility/margin", + "utility/max-width", + "utility/padding", + "utility/position", + "utility/space-between", + "utility/text-alignment", + "utility/width"; + +$body-color: #1c1c1c; +$body-light-color: #2a2a29; +$body-text-color: #f0e7d5; +$heading-text-color: #e8e8e8; +$primary-color: #ffcc00; +$primary-light-color: lighten($primary-color, 25%); + +:root { + font-size: 14px; + line-height: 1.5; + font-family: 'Open Sans', sans-serif; +} + +code { + font-family: 'Inconsolata', monospace; +} + +body { + color: $body-text-color; + background: linear-gradient($body-light-color, $body-color); +} + +header { + background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAAECAIAAAAmkwkpAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTnU1rJkAAAAHklEQVQYV2PQ0tIyhQEGIIbzQRwggPChHCDQ0tICAPUsCW2mN2EYAAAAAElFTkSuQmCC'); + background-repeat: repeat; + border-bottom: 4px solid #434343; +} + +main { + + h1 { + font-size: 28px; + } + + h2 { + font-size: 24px; + } + + h1, h2 { + color: $heading-text-color; + font-weight: inherit; + line-height: 1.1; + margin-bottom: 10px; + } + + img, + p, + pre { + margin-bottom: 20px; + } + + blockquote { + border-left: 3px solid $primary-color; + padding-left: 20px; + font-style: italic; + } +} + +a { + color: $primary-color; + text-decoration: none; + + &:hover { + color: $primary-light-color; + } +} + +pre.highlight { + background: rgba(0, 0, 0, 0.125); + border-radius: 3px; + line-height: 1.25; + overflow-y: auto; + padding: 8px 12px; + scrollbar-width: thin; +} + +p code { + background: rgba(0, 0, 0, 0.125); + border-radius: 3px; + padding: 2px 6px; +} + +.highlight { + + & .c1, + & .cm { + color: mix($primary-light-color, $body-light-color, 50%); + font-style: italic; + } + + & .k, + & .kt { + font-weight: bold; + } + + & .m { + color: $primary-color; + } + + & .p { + color: darken($body-text-color, 50%); + } +} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..920966fb5 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,8 @@ +--- +--- + +![](assets/images/moq-icon.png) + +Welcome to the documentation for version 4 of Moq! + +[Quickstart](https://github.com/Moq/moq4/wiki/Quickstart) \| [User Guide](user-guide/index.md) diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md new file mode 100644 index 000000000..3e55da03b --- /dev/null +++ b/docs/user-guide/index.md @@ -0,0 +1,6 @@ +--- +--- + +# User Guide + +This is work in progress and currently under construction.