Skip to content

JoNilsson/machine-shop-tutorials

Repository files navigation

Machine Shop Tutorials Wiki

Deploy MkDocs Markdown Lint

A comprehensive wiki-book for machinists, fabricators, and makers.

πŸ“š Visit the Wiki

View the Machine Shop Tutorials Wiki β†’

πŸ”§ About This Repository

This repository contains the source for the Machine Shop Tutorials Wiki, a comprehensive guide covering:

  • Drill Press Mastery - From basics to advanced techniques
  • Band Saw Operations - Horizontal and vertical saw expertise
  • Precision Layout - Bolt circles and coordinate calculations
  • Fundamental Skills - Essential machining foundations
  • Measurement & QC - Precision measuring and quality control
  • Shop Efficiency - Time-saving techniques and custom tooling

πŸš€ Quick Start (For Contributors)

Using Nix (Recommended)

nix develop
make serve

Manual Setup

pip install -r requirements.txt
mkdocs serve

Visit http://localhost:8000 to view the documentation locally.

πŸ“ Repository Structure

.
β”œβ”€β”€ docs/           # MkDocs source files (the wiki content)
β”œβ”€β”€ site/           # Built static site (git-ignored)
β”œβ”€β”€ mkdocs.yml      # MkDocs configuration
β”œβ”€β”€ flake.nix       # Nix development environment
β”œβ”€β”€ Makefile        # Build automation
└── [legacy dirs]/  # Original tutorials (now contain redirects)

πŸ”„ Legacy Content

The original tutorial directories now contain redirect notices pointing to the new wiki. This preserves existing links while guiding users to the improved content.

πŸ“„ License

  • Content: Creative Commons BY-SA 4.0
  • Code: MIT License

See LICENSE.md for details.

πŸ‘€ Author

Johanness A. Nilsson
johanness.nilsson@terraformindustries.com


Building the future, one chip at a time.

About

Comprehensive machine shop tutorials and reference guide for machinists, fabricators, and makers

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published