Team Anant Wiki

MkDocs-based wiki for Team Anant, documenting satellite subsystems and projects.

Prerequisites

• Python 3.6+
• pip

Installation

pip install mkdocs mkdocs-material pymdown-extensions

Local Development

1. Clone the repo: git clone https://github.com/team-anant/wiki.git && cd wiki
2. Serve locally: mkdocs serve (opens at http://127.0.0.1:8000/)
3. Build: mkdocs build (outputs to site/)

Contributing

Subsystem members: Create a branch named after your subsystem (e.g., ADCS-updates or EPS-fixes) and optionally include what you're changing. Make edits to Markdown files in docs/, test with mkdocs serve, commit, and submit a pull request.

For general contributions: Edit files in docs/, test locally, commit, and push.

Documentation Features

Adding Images

Place images in docs/assets/images/. Reference them in Markdown: ![Alt text](assets/images/image.png) You can also refer to the images using inbuilt html <img src="../img/screenshot.png" alt="Description" width="500"> it is easier to control the dimensions and size of image

Typesetting Math

Use MathJax for equations:

• Inline: $E = mc^2$
• Display: $$ \int f(x) dx $$

Enabled via the arithmatex extension.

General Resources

• Tables: Use standard Markdown tables: | Header | Header | then |--------|--------| and rows.
• Popups/Admonitions: Use !!! note "Title" for collapsible notes, warnings, etc.
• For more features (diagrams, code blocks, etc.), see the Material theme docs.

See MkDocs docs for general Markdown help.

Additional resources:

• GitHub Markdown Guide for basic syntax.
• PyMdown Extensions for advanced features.
• MathJax Documentation for math typesetting.