EE1101 — Electronic Systems and Circuits

An offline-first, static interactive textbook covering the complete 73-chapter EE1101 course. Canonical prose is preserved in Markdown; the browser experience is generated into a deployable static artifact with optional, accessible circuit models.

Requirements

• Node.js 22 or newer
• Python 3

No package installation is required.

Build and verify

npm run check

This rebuilds the complete site in dist/, validates all local links and fallback widgets, runs the standalone Python suite, runs the electrical-model tests, and checks JavaScript syntax.

To preview the generated artifact locally:

npm run build
cd dist
python3 -m http.server 4173

Open http://localhost:4173 in a browser.

Repository layout

• content/ — canonical textbook Markdown; do not edit generated pages instead.
• static/ — browser runtime, widget modules, service worker, and bundled KaTeX assets.
• scripts/ — generator and static validator.
• tests/ — standalone build and numerical-model checks.
• dist/ — generated deploy artifact; intentionally untracked.

GitHub Pages

The Pages workflow rebuilds and publishes dist/ after each push to main; pull requests run validation only. After the first push, set Settings → Pages → Build and deployment → Source to GitHub Actions. The workflow then reports the published URL in its deployment record.

Contributing and support

Read CONTRIBUTING.md before proposing a change. Textbook corrections need a chapter reference and a supporting source. Use the issue tracker for public defects and improvements; report suspected security concerns privately as described in SECURITY.md.

License

Website code is MIT licensed. Course textbook prose remains subject to its original course and institutional rights; see LICENSE.