From c1bf66223032b8aedbdd43ef1f98058755672f61 Mon Sep 17 00:00:00 2001 From: Haru Date: Fri, 12 Jan 2024 00:39:45 +0100 Subject: [PATCH] Add mkdocs configuration --- .gitignore | 1 + .vscode/settings.json | 13 ++++++++ docs/assets/Hercules48.png | Bin 0 -> 4954 bytes mkdocs.yml | 62 +++++++++++++++++++++++++++++++++++++ 4 files changed, 76 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/settings.json create mode 100644 docs/assets/Hercules48.png create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..87a15c2 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.venv diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..8bc4ead --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,13 @@ +{ + "yaml.schemas": { + "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" + }, + "yaml.customTags": [ + "!ENV scalar", + "!ENV sequence", + "!relative scalar", + "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", + "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", + "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" + ] +} diff --git a/docs/assets/Hercules48.png b/docs/assets/Hercules48.png new file mode 100644 index 0000000000000000000000000000000000000000..0228939532a998aaa70782f06a84837c9b98b511 GIT binary patch literal 4954 zcmY*dby(Ehy8R8^4AKY;9a1Ao!$^tL&`Otd56pldEl5b0bTbIjFe*w5NHdg()Sw~? zf(#)Y2fuUfx%ckpd3UV6-nI6-_kTOyK<^$k1seqb0MuHV>PA;1^ly-nT=k{|$FWxf zk&6mk1pt~-D9`MPuhv`+nnrK{cq{+_5zzo}as@^F1OWf5#0@(Dkk0`CW<sDIciB^AAJ*YW^3N;Nkj*g7Q$}F@qa$srmRhaY>2a7Kie{D7d(|6#X2X<&D%e z{*!*SQsQw%p%C&C5|17|5`T0{+{e#F;-;LOoCH)-LQ+!fiXny!@|1I)A zI_geH2R}Ci%FV}{>#wf;Lmz*X5)aQ`qyM&lpA+Tg{J&1#$p4geRiMP*9f_ObP>KI) zU!^MkMdkJV+?=kQ|LVhTD*nU#f7pL~6ea$e|DVJByV8Hqt5RVUiW2|5HW-EOdqHym zp!3jDS21xVMw?S2?tk)M`f;(GvA+)j5pa`}6G^l1rb0o%F;CpA71sFzt|`j8yWrmMXivTeb@1}!=hlA$9Bg7?9@v5t*@cSr+O*9B1N~w)`c;gbBnnY6l%BTCpYbH zEs~|p+S}W!(&ZIgbK{1hoA*J$*8F#eO8i>OQhTh$EB7q_J?}2x6e5l1j{*XcZFwzB z;ixrVj#6Lb$aAroXmKyEku_G0Mj@(>JgA8Z%gMJ7eW5-m>fQ;eC*3=tcha!I(qahw zN*J@l;=#eea_5&Xp)Zmlci6BuneHvZ4&*7QUeVloyovGr{ERe{0`gSFG%lTiniBkU zXUBgN<*|LQvQc-B+qvM|cp z+ENZFT(l!{SL`n6>o^BTO=Tv3lnZ<$u-hPp$ezorU?TGJr2C#&L>O9$7vC9intl(? zcdgk6x3Ier?wt`6le?>JnQzgEQR&F>%(Pu4s2-{aM@i?KhnKds$$XGuH@H z&Jwu}dVG&3t$@~;R9l!fD->Z!(bc4?Qz_JuWWq_#77u(b_19l%Psje?|02tF76rL% z#o(GuNK)9JYwOzc7p{m)t@`u3k43vJ+g>MnlZh<~m0+2q|0ZHB-1%ljljLQro>l}d zU6Y{w#}D0J6xB3Jbee(wBa}+putHt2=TAKY4__dTUY%=bt+~-zNIcr^xHlF;N4OQ- zH7`u%+nHhTC#<+dQunFCmZP_y`RB9tALotcj{MPsWt45iRprkk7;w3rMs@Kng8X)x{JO&U+#S{2C{QaG`+R6w_#VktA|J%kl_H5QRrB{A0v z$jEDt#yr}wd}-y38fhXZ+`Tv}xtnz#8|cwz+yW_hj$!5GOpA;RV`XJc3$to^F{r;B zXv{YJh4fG?`>Z7HvynuG^9jMLc*fP$Y?}4_WyA(C zCt@1x4D$7oi8bvmyuOlb{Zf^aW@kG{qGe)yZDPgrlOu_HDUb{_rB8O2$E@bbQn}>W zs<9EQL2nZUsrBp~j+_$^a=DSaNj1ErS6l%X!4wjOA{c!c4g@zE%@Wtv*7%An$g~N2 zJ>*415X_m0GU(wLq=w#0wc1KbVYPbFNZUAhbF$RuqL}R-w)HRe$1@HoLlusyC(=rS zi_Z!jjo81xpIRXyDq-}bq-tW%wGFeGHDmRkZA4E=z9qWtqfUe1*WHU}c)C+NYML zFtk4SehO}@nT4GMa(461JAygyX-v(>-@=2Qr_@>s4q0h5W6v|@{!FwI;Id+W#sr&C z(haJ=DgaMXAfG%yz6^G6-G^;?@s(-B^oys3|~fAfyQgOhjEp z?ZGGOG@21=85_q$R$Gio!~@hsS-Cqb7+AA?lfDh}AX`4I*JEUnpDv*pDC|OMIopll zE+%68S_5sKxXAaD(Chk;O_C(n^oWp^tPlcY6e{2zdty6PXs&r-8djQ`WNN9e&&MjB zhztI~pkI*Rj66Ac$l|fBtHYfq{!MO9djRc#(|#$fwd|t@oWZ+V)y2~H{T8}UIbB=* zV$AGqEMvRBJ<}ATik{~ownz9Jm4pN@*^L~eT!g?TyE<&PiSMd#i4?pVbRtvrNQG&D z`-9oUcky3Kj$)oWaA)OIIZd0p-uZf_KuSCOQeiujQN&aWvDwISdDif?))gqDBQJ5M zn%ujtLAJs`1XBS)A!2H#{UW{hq>U^~)3qhTlV(#yLmybxKAQlGc_U(HEGh&H$pt#o z_4dh)zRycdb&}%WdeV&R3^*>Rz0X=t_xhg&dA7E(tW?4v?Pj&z^lEhp4LF9lhl7# zoR>Dh$`wZt-$uict`FN!74`I>569Uw+02R0)&@O1?Oh4tZn!ZKdkR-CuYs)qvduZI zY=HqHjh0!aM1_TZ`Q>#JtXq_g%IcAty)$7T7CBBzgGTLYG-{?Nc#LG*8&-rqWhB13l(Q*L(VUjzIqRGyzeHb+&Kuyi6J`6n8vodzPhJ zY$CRnT$c{0zG&CJra5(Oq7x3kWp(Xsr|RiZIizm~qU_LJM#lam7v)S5I|?K1=N~!y zvwh*V6RX0M;rQe1L8%BBdD1OIBrceot-2E~Pv zAE41X_Q1x=9X@cqLyaHY1Chw9QW4p$dT0|z*WVwM61)DfRJjTmb#0(`tjeL&-lmgf zdBXJ@li8fL?qBw)BMn%A*V^lS2$tWRQw5m?qG=}xHb>xzPFs*ri%PquXI|I@FvYC6qnktzVsIUJb@xIhWh9$2 znE;crp*3+gi)HKg#73%GMg>Xi$Uq7tTd)&PY>shkGTHph{XN*0IsD7Rrd?BvKZ`)M z${_ty-G~>^chQp_)|SEnQWj)IY@gzGMmD$DnBsVzrfCjXIHDj&fgW87I~ zf$U@T&4p}DoFJGljyu>~k++(VKx*W|b#|VZC=~MkT68~(gtCPmGGSEZ=@PLMLHYjp zEte)+>D$YR?j7@R#7~^=W?yx4b2HYC2*$CIW5#T^a<=aVCW@m35!U>}nUI9anyY>;Y1VH9%il;)vN(V5eR8!9R z{Jgx??#QUA%U`x5q|e2P`PX!$KZ?%k+km^8nUIssno7WYIWQq~#_HEYFjpe*MlKBi ztQmm!>fOEu!zX09r9mel-mBOmx$`9Yj*CZ4s0WlQvg5pgRgunaGG38$6b_Nuu<{1+ z%>@1L7IDQ}%hbP4{Yaxz<=$v6=Zbz9kb zEGW9)ui&awyi>wOwM)2XRD2z_w~^)JGoODU&BUoHr7K!=LqZ~)$d=#zC%NZL6~!Gk zD4d%5`I8??I*S_IIiIDaZx1IIDxlv<^6Shm^hbfk3(PuN;b$kT6F;G<&?-{hpwTa1 zEQM$=Mp6(s(cgsMK)oQX~*0AlRE zq8UL!L1$UI!6eE+$PxTqrHU)zx0?J|&P}zjv)z%YsX0E%d8Pz~;G)*g+~lu2gu{Au zcUsQVX&KG{RWOuh=i?g-vImV6M1GT%J-jJvNZ9qN!qaJm&UW;+h;jfymflOLs$QWz z$kVMfs;QYsPn3(YTGy}ang@0e=M2Rvq7zN6;=qUBvMXM`vv`0DE~X0G(C=#tF-$bY zrLH8)eWfX)|D?;s-@}GjWv_a2p4B-XS1lYG4VO6M`v;v&!1y6OzdlZXs0HebbEZno4{l@nPR}{5HD+tz77r`}T7rm}%D)D8)ln zK%!j+Ru1}c%`;@O+q@vzp8Fu)JVUZI4P89mmL(v~zc^4cxoa}T1xvcp5E_Zl=Ut0*e|z}?B3YZH$&fl$Rt?a z=Z$pG?jL1`De$iMS}bMj9xv)mKk~ZiEO+cRAc4LF9Vy|fezseP9NCBUOGdYIUM^_9 zc9_(TxGNd$MW02tc1Z#ItzU!3+|?P)lhO(MbFi@TSnqj*nfRYLJsV_s!NNX-C&QiZ zV+kVSaMiPzG0fr3dNId`!v@C-KkWBX2|~!_@rz!8p65&y%GHXZ^R%`Id~T?CV8Q!a zXOTseXD2QM^RWl};AEj{T?W$Fm~6j7&9KGb@t)x=j?PN3&Bu|3_Ogu^`lch>?{q#&xS6^<#@38hTW`cNv&|gzs=4dc zeG1*(#kX{yZ?i1e<`7!3*ggccl8u;0tc0t#!fEZ`MfcJH>)oA4n1EN64dp@JyiNSF za>D&!1^*3`&+S1iqH6EbG$fDew$BpSw|N%7+y6}Sj-@Mbf18kBU>`ZoZvcL`G*zXuf!CSF0Pxj8(;4_6ZU`AI>sbSPh~H6 z@HIo~P7O#6bZ#;#WH0ySr7UQZ8k{Co-7@qr+(ECM5^-5en&p^=T!U!^Ec7a0jEZB*xw&4t-E^a J^{RGH{sm0{06qW! literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..5965532 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,62 @@ +copyright: Copyright © 2013-2024 Hercules Dev Team +edit_uri: edit/master/docs/ +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/HerculesWS/Hercules + - icon: fontawesome/brands/discord + link: https://board.herc.ws/discord/invite/general/ +markdown_extensions: + - admonition + - attr_list + - def_list + - md_in_html + - pymdownx.critic + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + linenums_style: pymdownx-inline + pygments_lang_class: true + use_pygments: true + - pymdownx.superfences: + custom_fences: + - class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + name: mermaid + preserve_tabs: true + - tables +repo_url: https://github.com/HerculesWS/hercules-docs +site_name: Hercules Docs +theme: + features: + - content.action.edit + - content.action.view + - content.code.copy + - navigation.indexes + - navigation.tabs + - navigation.tabs.sticky + - navigation.top + - toc.follow + - toc.integrate + favicon: assets/Hercules48.png + logo: assets/Hercules48.png + name: material + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to system preference