Skip to content

README.md

Latest commit

 

History

History
63 lines (37 loc) · 1.21 KB

README.md

File metadata and controls

63 lines (37 loc) · 1.21 KB
Raw

Book of Notes

bookofnotes is a clean web notebook for engineering course material.

It renders lessons as native pages, with searchable sections, static PDF downloads, math support, images, tables, and copyable code blocks.

Installation

Requirements

Procedure

  1. Clone this repository to your machine.
  2. Run npm install to install the dependencies.

Usage

Development Server

npm run dev

Open the local URL printed by Vite.

Build

npm run build

The production files are written to dist/.

Content

Courses

Course pages are stored in data/ as TypeScript content modules.

Assets

Static assets are stored in public/.

PDFs

Published subject PDFs are stored in public/pdfs/ and downloaded directly from the app.

Development

Structure

  • components/ contains the React interface.
  • data/ contains the course content.
  • public/ contains static assets and downloadable PDFs.
  • scripts/ contains local maintenance helpers.

Check

  1. Run npm run build before publishing.
  2. Open the affected course page and verify layout, code blocks, images, and PDF downloads.