Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MA1101 — Mathematics for Electronics I

An offline-first, static interactive textbook covering the complete MA1101 course. Canonical prose is preserved in Markdown; the browser experience is generated into a deployable static artifact with optional, accessible mathematics visualizations.

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 static widget fallbacks, runs the standalone Python suite, runs the mathematics-model and learning-bridge 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 plus interactive learning bridges; do not edit generated pages instead.
  • static/ — browser runtime, math visualizations, service worker, bundled KaTeX assets, and bundled local fonts.
  • scripts/ — chapter generator.
  • 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; bundled fonts remain under their included SIL Open Font License. See LICENSE and static/fonts/LICENSE.txt.

About

Offline-first interactive textbook for MA1101: Mathematics for Electronics.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages