From 6359a71e0941dd4d2650378bf74b272d03bd8eb8 Mon Sep 17 00:00:00 2001 From: e Date: Sat, 15 Jun 2024 19:47:30 -0700 Subject: [PATCH] Add LaTeX Support. Add mission --- .mkdocs.yml.swp | Bin 12288 -> 16384 bytes docs/cad.md | 1 + docs/calculations/calculations_arm.md | 0 docs/calculations/index.md | 4 ++++ docs/contritube.md | 20 ++++++++++++++++ docs/javascripts/mathjax.js | 19 +++++++++++++++ docs/mission.md | 2 +- mkdocs.yml | 33 ++++++++++++++++++++++---- 8 files changed, 73 insertions(+), 6 deletions(-) create mode 100644 docs/cad.md create mode 100644 docs/calculations/calculations_arm.md create mode 100644 docs/calculations/index.md create mode 100644 docs/contritube.md create mode 100644 docs/javascripts/mathjax.js diff --git a/.mkdocs.yml.swp b/.mkdocs.yml.swp index 6c1095778015be27e055a7f06aa76a772627a24b..77deee9d78936ee0241cfab70cf309be727d01ff 100644 GIT binary patch literal 16384 zcmeI(dx#ZP90%~@_R!T#&070I;*>^3%^h_!@?zjW%gT!N?991yk2`Z_m~&A4g2c=8ac#SM|BE^wU`QZq(z)o+=GQVRI`xXA`gqobd!QU2$$4PugeA%)jc> zuDF~|zUb~Vz8l-2O~58#6R-)`1Z)B}0h@qLz$S3^CZLlRvId9OQai*8Yp zpIdvqci8&ctbMTw*aU0>HUXP}O~58#6R-)`1Z)B}0h@qL;4Dml`Gjmo(cd}&2Z!^Og z0fSq?g*G^T0U_VP$FLPPz|){$1$4mGFadrYN5}#A5H`UJFaRrIF_hpEI5w7$gRmR6 zz>Ba3D$ohn!#Mc4m5}}L4!i=7f`Fya4wu65F@$^zyI?as54~_d%!eysEF2k4$UfK( z8{rYCLMP0EDRAt3LcW2IU=utC8LWVLFdbUq@Ogyng}32lco+g$0yCiv{y3MAuVE*= z3D1It``~7n22)@MJOxie1`k39Tm_S$1rFh%&wkhiTVVsNg#qY?F1Q13huJU{#=vO! z1rLCOtvPiz7E;y1I(>&u@3Rn(b=d??h4PcvT&RrB#Xy z-6)B}fr<#jl8D{jcDFGb35lljDxB#o#_v@5(4X!K` zv^G<~B~OJ{raH|yF?&u1B0uhv{Uw$PUB#jD{xXSJia%cIlU?YDOC@5dPPdD^bEb9L z6$+)BcV)V7UZS#urxh+eUgXg@D*6vj4!w&jP20^b>hF;Zmf<8RU5b2SSJ^b|wPC*w z#V-o`%i%xz`>^;}jSts&qyO@Z+Z8AL3uz-ctw`)erv7(dFJ0vk$DK5xgYV3B&^(6) z#qFs1Mm4W$o;yjy6Z+KkP0jusx}alWnR?7GZgL&EkSh_$GBIn-`i?ZZjxI4xLN5!M zHYI>Nbf$}?(cm32nxjG}HXYi^71HPZ^_?sj(pj0-ns*9i3XC$1iZ}Jfi@DZ926UNb zspfu}NY;z!l+e5@OT%)b(5n5teTj);rDVvM)|L`e|Ib9tI|uc#ssHQa`$tg6AB0cf zE!YT8Kng2hE=&hg|6dG~VGJBajsHEEx_<*a1}QuMOJORsz+u$*U%=4Uk|y`z*K& zTHy%tu#-)|CSVh=3D^W|0yY7gz`s3#{J!1XyN^5qG2)t$7S@)Hw91ZU{GG83pKB(< zVt}I($6Cf1X2`3cQy!QxCx!V@EQP7au6qrR(+J0Bx*_I=nTqH}K1Pzapd%la zLiL^>dBQ@J)aLO6r6H3+#sbvIT$*`vA>rI$uutRs`5ZrzBDrD9nZ#9_KMokSm1f%XAkL9m)?Hl(*%b>fuKN8 zASe(N2nqxRf&xK-pum4u0bA{nj}YEtU5Hn^>)xqr_c2_80zrYGKu{nk5EKXs1O)qfz%0xGPg>q1^^5uA0(pU+O<*DMVgKU`JQ#%-v?Y zM4IxY<;q~aCc)RSwvpE1x-3qAen6S@=7gTS^B&g@orC_~zplN99_WhJ@A0}U2KnLh zzwJ4rSyzgtIjj9y?b;IeCH4?Qx~d#3uCG1Uc~WE4w_zy_hHci2yRlIo1G{w*40;F2 z-p)0i(}PhP$vd8a-x0Y;xht#5qKHrYTo8p;c2?lJ~h@ z)dEqkP^_Fu;tlcQpCk0^x{J8f9~BW7ZCo=YAXZyD*?EYgj2CqVDNHAwt; zgq9W@Pbix48EgCk+>Cu>Qk4Bf>#!DuJ9(UyYlFC~rvA{NB?5GJiF# diff --git a/docs/cad.md b/docs/cad.md new file mode 100644 index 0000000..9ef9112 --- /dev/null +++ b/docs/cad.md @@ -0,0 +1 @@ +# CAD diff --git a/docs/calculations/calculations_arm.md b/docs/calculations/calculations_arm.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/calculations/index.md b/docs/calculations/index.md new file mode 100644 index 0000000..87c8091 --- /dev/null +++ b/docs/calculations/index.md @@ -0,0 +1,4 @@ +# Calculations +$$ +\sum T_{A_\circlearrowright} = \beta \cong -T_{mp} - T_{M_3} - T_{M_2} - T_{m_1} + T_{\text{Motor}} +$$ diff --git a/docs/contritube.md b/docs/contritube.md new file mode 100644 index 0000000..b2368a2 --- /dev/null +++ b/docs/contritube.md @@ -0,0 +1,20 @@ +''' +#Contribute +## Using MKDocs +### Equations - LaTeX Syntax +Use $$ to start and end LaTeX notation: + +``` +$$ + +\sum T_{A_\circlearrowright} = \beta \cong -T_{mp} - T_{M_3} - T_{M_2} - T_{m_1} + T_{\text{Motor}} + +$$ +``` + + +Renders as: + +$$ +\sum T_{A_\circlearrowright} = 0 = -T_{mp} - T_{M_3} - T_{M_2} - T_{m_1} + T_{\text{Motor}} +$$ diff --git a/docs/javascripts/mathjax.js b/docs/javascripts/mathjax.js new file mode 100644 index 0000000..0be88e0 --- /dev/null +++ b/docs/javascripts/mathjax.js @@ -0,0 +1,19 @@ +window.MathJax = { + tex: { + inlineMath: [["\\(", "\\)"]], + displayMath: [["\\[", "\\]"]], + processEscapes: true, + processEnvironments: true + }, + options: { + ignoreHtmlClass: ".*|", + processHtmlClass: "arithmatex" + } +}; + +document$.subscribe(() => { + MathJax.startup.output.clearCache() + MathJax.typesetClear() + MathJax.texReset() + MathJax.typesetPromise() +}) diff --git a/docs/mission.md b/docs/mission.md index 1a6d337..7b659ed 100644 --- a/docs/mission.md +++ b/docs/mission.md @@ -1,2 +1,2 @@ # Mission -We are designing affordable full DOF humanoid robots incrementally, halving the cost until the BOM is $1000. +Design an affordable full DOF humanoid robots incrementally, halving the cost until the BOM is $1000. diff --git a/mkdocs.yml b/mkdocs.yml index e780e9e..c19bb43 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,30 +1,42 @@ site_name: ondroid site_url: https://ondroid.ai + +nav: + - Getting Started: + - Mission: mission.md + - Calculations: + - calculations/index.md + - Arms: + - Arm, L: calculations/calculations_arm.md + - Design: + - CAD: cad.md + theme: name: material features: - - navigation.tabs - - navigation.sections - - toc.integrate + - navigation.prune + - navigation.indexes - navigation.top - search.suggest - search.highlight - content.tabs.link - content.code.annotation - content.code.copy + language: en + palette: - scheme: slate toggle: icon: material/toggle-switch name: Switch to light mode - primary: white + primary: grey accent: lime - scheme: default toggle: icon: material/toggle-switch-off-outline name: Switch Mode - primary: teal + primary: grey accent: purple plugins: @@ -49,3 +61,14 @@ markdown_extensions: - pymdownx.mark - attr_list + - pymdownx.arithmatex: + generic: true + +markdown_extensions: + - pymdownx.arithmatex: + generic: true + +extra_javascript: + - javascripts/mathjax.js + - https://polyfill.io/v3/polyfill.min.js?features=es6 + - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js