Coder Social home page Coder Social logo

shopdocs's Introduction

shopdocs

(work)shop doc(ument)s

A couple times a year or as demand warrants it, I teach a workshop on electronics and DIY synthesizers. This repo is the source to the documents I write to share with my section.

A "live" version is available online with nice PDF downloads: https://rocktronica.github.io/shopdocs/

(Importantly, this is the source code for resources I made for my section only, not the other instructors' stuff nor the real core material. Any opinions or errors they have are all mine. Obviously, it is no replacement for taking the actual workshop!)

Blog post: https://blog.tommy.sh/posts/shopdocs/

Notes:

  • It's mostly supplemental stuff that got cut for time but still useful/cool enough to warrant sharing.
  • There is no prescribed reading order. They're kind of grab-bag "jelly bean" docs to share as topics come up.
  • Despite being a real live website, format is optimized for PDF and print, so as to be put on the class Google Drive.
  • I expect the content to change over time, so everything's dated by last update in the footer. Depending on when that was, what's online may be different from the PDFs I share in class.
  • Schematics were done in Kicad, drawings on an iPad.
  • Some stuff might not make sense outside of the context of me talking about it! (Other stuff might not make sense because I wrote it very tiredly in the middle of the night without spellcheck before class in the morning.) Typos,

Generating PDFs

Document files are written in markdown, made into a website with eleventy, and then converted to PDF with Chrome via puppeteer.

npm install

# Terminal 1
npx @11ty/eleventy --serve

# Terminal 2
node make_pdfs.js
node make_pdfs.js SLUG # for single PDF

Works For Me!

TODO

shopdocs schematic cards

  • Per page footers w/ page numbers
  • Smarter make_pdfs.js URL confirmation

License

CC BY-SA 4.0

Text and drawing content is all CC BY-SA 4.0. Please retain my attribution if sharing, TYSM.

shopdocs

Code is MIT or as components allow.

shopdocs's People

Contributors

rocktronica avatar

Stargazers

Brian Degger avatar aarón montoya-moraga avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.