Skip to content

tslateman/tutor

Repository files navigation

Tutor

Personal reference site -- commands, mental models, and lesson plans for software engineers.

Live site: tslateman.github.io/tutor

Content

Section Directory Count Description
Reference src/content/docs/how/ 33 Commands, syntax, quick reference
Mental Models src/content/docs/why/ 15 Principles, frameworks, heuristics
Lesson Plans src/content/docs/learn/ 26 Progressive 8-lesson plans with exercises

Development

npm install           # Install dependencies
npm run dev           # Start dev server
npm run build         # Production build
npm run preview       # Preview production build

Linting

brew install markdownlint-cli prettier vale lychee
make sync             # Download vale style packages
make setup            # Install git hooks
make lint             # Check style (markdownlint + vale + links)
make format           # Format with prettier
make fix              # Format then lint

Adding content

make new NAME=foo TYPE=how    # Scaffold new guide
make new NAME=bar TYPE=why    # Scaffold new mental model

Built with Astro Starlight.

About

Personal cheatsheets for developer tools

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors