Skip to content

Michael-Jetson/Robotics_Tutorial_Wiki

 
 

Repository files navigation

Robotics Tutorial Wiki

MkDocs Material site wrapper for Robotics_Tutorial.

The source documentation repository stays clean: Markdown and media are synced during build, then rendered as a Wiki-style static site.

Local Preview

python -m pip install -r requirements.txt
DOCS_SOURCE_PATH="/home/gpf/Nutstore Files/Robotics_Tutorial" python scripts/sync_docs.py
python -m mkdocs serve -f mkdocs.generated.yml

Vercel

Use the included vercel.json:

  • Framework Preset: Other
  • Install Command: python -m venv .venv && .venv/bin/python -m pip install -r requirements.txt
  • Build Command: bash scripts/vercel_build.sh
  • Output Directory: site

By default, the build script pulls:

https://github.com/Michael-Jetson/Robotics_Tutorial.git

For a private source repository, add DOCS_REPO_TOKEN in Vercel project environment variables.

Credits

The homepage hero layout and illustration are adapted from Material for MkDocs, licensed under MIT.

The homepage aurora landscape photo is by Jonny Gios on Unsplash, licensed under the Unsplash License.

About

Documentation that simply works

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • CSS 46.8%
  • Python 24.9%
  • JavaScript 23.1%
  • HTML 4.4%
  • Shell 0.8%