Skip to content

Commit

Permalink
Add LaTeX Support. Add mission
Browse files Browse the repository at this point in the history
  • Loading branch information
e authored and e committed Jun 16, 2024
1 parent 3b1615f commit 6359a71
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 6 deletions.
Binary file modified .mkdocs.yml.swp
Binary file not shown.
1 change: 1 addition & 0 deletions docs/cad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CAD
Empty file.
4 changes: 4 additions & 0 deletions docs/calculations/index.md
Original file line number Diff line number Diff line change
@@ -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}}
$$
20 changes: 20 additions & 0 deletions docs/contritube.md
Original file line number Diff line number Diff line change
@@ -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}}
$$
19 changes: 19 additions & 0 deletions docs/javascripts/mathjax.js
Original file line number Diff line number Diff line change
@@ -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()
})
2 changes: 1 addition & 1 deletion docs/mission.md
Original file line number Diff line number Diff line change
@@ -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.
33 changes: 28 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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

0 comments on commit 6359a71

Please sign in to comment.