diff --git a/.mkdocs.yml.swp b/.mkdocs.yml.swp index 6c10957..77deee9 100644 Binary files a/.mkdocs.yml.swp and b/.mkdocs.yml.swp differ 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