From 6610a05b8299adb8c6467a2cfc90acf2f78be581 Mon Sep 17 00:00:00 2001 From: Sameer Rahmani Date: Fri, 19 May 2023 19:19:30 +0100 Subject: [PATCH] docs: Finalize the mkdocs setup --- docs/imgs/serene.png | Bin 0 -> 3892 bytes docs/index.md | 37 ++++++++++++------- docs/javascripts/mathjax.js | 18 ++++++++++ docs/requirements.txt | 1 + docs/resources.md | 5 +++ docs/stylesheets/extra.css | 12 +++++++ mkdocs.yml | 69 +++++++++++++++++++++++++++++++----- 7 files changed, 121 insertions(+), 21 deletions(-) create mode 100644 docs/imgs/serene.png create mode 100644 docs/javascripts/mathjax.js create mode 100644 docs/resources.md create mode 100644 docs/stylesheets/extra.css diff --git a/docs/imgs/serene.png b/docs/imgs/serene.png new file mode 100644 index 0000000000000000000000000000000000000000..a0d160cc45e1111c23932c1dc1b2b8dec5fd1a8d GIT binary patch literal 3892 zcmV-456ke0P)KX(mM$_OdtVkxCbx`$ax`JYnC=zHDY z27{DRBc+@!rOfs)a989>Dd$KjwT<0B(U_G>DF*^efUY&=1-FYyU2>AV3k3i~cZi_x zobE)l2y?CC0`RI3Vn<{3u~8HtrA!9i2PV{%7hEr9-IP5P{%Aqi1C(VnHuQZ0nY?BQ z5v^5<*bBTOggDpGeQi($NGT(Lw}6*{Acx#;wX<#BA<{p~LSym#Rok>y;wMHh>B}Jm z1}l_g29^Q~gb)P{)#nCLfRs`LOa(p!3^mh!Sbl=Te@;VF6jWM*UW|gpU>OS)JS0JSO>ZPz#5S|S{M3Dg@H6HRx!ux2LvOWcU zT&?^tM+kAgF5~c90aD6P;B{a=5aN*gW9P-8d1OUj!4hZ!Kx+*qHZK8vaSXykm+V?A zttUn>dDRdCf)xB<0X_rX7D5#IGajE6;K|Mpe|D18Kb|MRi=CT-OUR18Oqs5z)^wdI zjONC+=uE1&tbi@lOwV`kW8iC#xF+QR?*Yq%5H^pMRKX_&NGbbMY3JQ)$}|7xHeXLa zg!z0xt>qlB23RphW|ALq3yJj7AwhU?ECyo&TAOEuig*j-SNElD-`1{4X;kvVE{_%9 zMFCRE)>O{t(`w2~jAg8!_C3bk-t1hGufI)BvkdGSuWv_Z8i&t|pp!=|Hb`s5pm^Gg+Jq2+oE# zuCJiq;?DG$)y*|2i^@gXDj|g3A#^H0O4$}z0ram~%3dj4p_qdb$F1Eqy!Y+bsGeXCQk+3bomeX+r3et2r_<0SQob4~gQcuokB4pj=M z8vM_Ia~oQeQ_8x@yU9Ob^*W#DMcl*~d0l1aoqFHTGjEQg)qO2g5Qekt3R?`H4nRP0r6R|rAxF^@3u z^-)B`gsaM&J92?F3pR7}x7!MNkR=3zF^RC!D3ATLg;;p(qxSTB>A{-fi$FIarJM_V z;*cKs;xwr<(>-doBB-3K=*yJ4*m+2kV1~^Y$cUMPRd#N**f_B6FkdhEj`9+v!W;T4A!<4ti)3#fJD(&`_ zY}PK^!kI(LEr7fkOx^ph|9hook>|H zsH2U!=bm;vN+G3me#?tv*C2A0pHF7Xv#L3L#H_)LeR-JL&dpYKe|3;={$r0@JFhEr zO+y$tdk87ds@D-#vz0ANck=D$-z(%z%OZ)t)mb5vF=qalGsXF=tjVTcr`v^6Hf+W~ zCd?bD%6ELvX*PVYjhsxQZzJ*(yI#L{%9T^QhofO4bn1U-bn0LJ3ChF zbK7@7HAeSTUkh|$I!3=ZR3XbuzscfhOIiBj%0?S}P2^-6S^DBi7EfDBX8KJ<+US>t zq6^dcRi9tSHElY?p=;`7P%IS|N(;&u`ENs*FmEIQ+5j|K4Z6_EJRzaMXaY2tO%|+X z_32e{F~49_@#iR zkxdoPfx&@v=$Y&$cQr!wwaa6uUcfv$tUFRle%W!-=lr?b>Wve7{Fjz}aNDx9J&_{=a4M> z@d@{w1Frs>sd!H8qTUvJgOrlme=d@pC8{PZr2|@_kKiW0%>bcvM#r;9@LrF|{O}(TBNa`AYS5}p9k2oNvRTM8Td!7Jo z?f!&z-4p9nuh0lWLWBJ(bJrCRs&B%)m9rEFC$3A^j=k^qtInX1Kn6VBhef;Iq)Xop zewDqeBp4PM%4=WFrbSYm}dTT33rC14Ex1 zK%X&>)QgAUE-9dWk7Q;qc~)_vb8`P#K7aKq=ZVpUW0&anR8MDm|4F_0_VYbdl$(Ld zDYHYbWKw?DU*T1%FB(+=fx&?cf8hy6y_iBkKsDX`wEZ|=%wL1eTJ1+jKdL-8437#U z<@WFF9l?ryMd{+!nxQOF>5d#d*8>J1)I5a@+$9+`;Cghz!@kfRRwY1Sf=NpFmz$M6SLGr_jyyZkfSdoot2qfn)=VT`Zmlv8?663); ztgRqBDubf1T%WzeQc8~PI>m+$w)sqkkp?|uUK+;Z6MLzqL5FwP)$dptT^55OF9EH! z_8p-+@37zT0jA&*ZpU1vJVbdA;VC}ATyEz3|4L>1^4*xql;-3>P)Hzyr$5f9*(s`R zt*7_^T}2p%+$5Tq)Xq}}JjDm-fK$MI4r%JL6C8d$odA>jjfO;07?w*;)K#onCElq{D%q(RRl~G~? zYUaFtGMi0P4|t6dvue#%{E*YAQDR}G&1i0HN1(;?$&ZI9u_M6qiYPG$8X`{66kI}9 z%w@`4_@TaWf*}=6F&L8wEqCK+tb$!%LB9_>)8_?0;{m#*p-E39h7OSHH*ez0gO$ceh9 z;sM2&M_peE{jW5mG^+0j>>`wNGi>x&Hkyf;Q%A*GC`a<)*MM-^q4 zvSG?zuXl#*8XE=Sm7#4BMa{k1xraMLUhUiy{x9DeO9STJvs+^|agXi|`fTT(@c%bQ z8>*t3_?Nvq> { + + + MathJax.typesetPromise() +}) diff --git a/docs/requirements.txt b/docs/requirements.txt index 233599b..08de461 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ mkdocs-material mike mkdocs-git-revision-date-localized-plugin +mkdocs-glightbox diff --git a/docs/resources.md b/docs/resources.md new file mode 100644 index 0000000..6bf09b5 --- /dev/null +++ b/docs/resources.md @@ -0,0 +1,5 @@ +--- +title: Resources +--- + +# Development Resources diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..2affd52 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,12 @@ +#what-i-cannot-create-i-do-not-understand { + color: white; + font-weight: 700; + margin-bottom: -20px; +} + +.md-typeset .md-annotation__index > ::before { + content: attr(data-md-annotation-id); +} +.md-typeset :focus-within > .md-annotation__index > ::before { + transform: none; +} diff --git a/mkdocs.yml b/mkdocs.yml index 81827ed..3a6c07c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,13 +1,17 @@ site_name: Serene Programming Language +site_description: A modern, typed lisp +site_author: lxsameer repo_url: https://devheroes.codes/serene/serene repo_name: Serene copyright: Copyright © 2019 - 2023 Sameer Rahmani edit_uri: edit/master/docs/ +site_dir: ./build/docs + theme: name: material - logo: /img/logo.png - favicon: images/favicon.png + logo: /imgs/serene.png + favicon: /imgs/serene.png icon: repo: fontawesome/brands/git-alt edit: material/pencil @@ -30,9 +34,16 @@ theme: - search.share - header.autohide - navigation.footer + - content.code.copy + - content.code.annotate palette: - + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + primary: deep purple + accent: amber # Palette toggle for light mode - scheme: default @@ -42,12 +53,6 @@ theme: primary: deep purple accent: amber # Palette toggle for dark mode - - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to light mode - primary: deep purple - accent: amber @@ -56,9 +61,12 @@ plugins: - git-revision-date-localized: enable_creation_date: true - search + # - social: # concurrency: 16 - tags + #tags_file: tags.md + - mike: # These fields are all optional; the defaults are as below... alias_type: symlink @@ -75,4 +83,47 @@ extra: social: - icon: fontawesome/brands/mastodon link: https://social.lxsameer.com/@lxsameer + - icon: fontawesome/brands/twitter + link: https://twitter.com/@lxsameer + - icon: fontawesome/brands/youtube + link: https://www.youtube.com/c/lxsameer + generator: false + +extra_css: + - stylesheets/extra.css + +markdown_extensions: + - attr_list + - md_in_html + - def_list + - footnotes + - tables + - md_in_html + - pymdownx.superfences + - admonition + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - pymdownx.arithmatex: + generic: true + +extra_javascript: + - javascripts/mathjax.js + - https://polyfill.io/v3/polyfill.min.js?features=es6 + - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js