admin2/openfreebooks-bookgenerator
1
0
Fork 0
mirror of https://github.com/HananoshikaYomaru/openfreebooks.git synced 2026-11-13 21:15:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Refactor math chapter structure and styling: Update .gitignore to exclude specific CSS directories, enhance CONTRIBUTING.md with new guidelines for subject-specific assets, and streamline chapter content organization. Modify curriculum data to include new chapter dependencies and improve frontend logic for loading shared styles and scripts. Adjust styles for better visual consistency across math chapters.

Browse source
This commit is contained in:
Hananoshika Yomaru 2026-05-20 18:07:39 -07:00
parent 5175811579
commit a2679aa4de
24 changed files with 2104 additions and 530 deletions
Download patch file Download diff file Expand all files Collapse all files

23
CONTRIBUTING.md
View file

@ -87,14 +87,17 @@ In `data/{subject}-curriculum.json`, set `"status": "live"` and include `descrip
Create `content/{subject}/{slug}/`:
```text
content/math/your-chapter-slug/
├── _index.md # page metadata (see below)
├── core.html # required — main lesson HTML
├── supplement.html # optional — history, checkpoints, extra demos
├── chapter.scss # optional — chapter-specific styles
├── assets/ # optional — images (synced to static/chapters/…)
└── widgets/ # optional — Solid widgets (auto-mounted)
└── my-widget.tsx # default export; use data-widget="my-widget" in HTML
content/math/ # subject folder (mathematics today)
├── subject.scss # shared CSS for all math chapters → /css/subjects/math.css
├── subject.ts # shared JS init for all math chapters
└── your-chapter-slug/
├── _index.md # page metadata (see below)
├── core.html # required — main lesson HTML
├── supplement.html # optional — history, checkpoints, extra demos
├── chapter.scss # optional — styles for this chapter only
├── assets/ # optional — images (synced to static/chapters/…)
└── widgets/ # optional — Solid widgets (auto-mounted)
└── my-widget.tsx # default export; data-widget="my-widget" in HTML
```
**`_index.md` front matter** (page fields only — catalog fields stay in JSON):
@ -115,6 +118,8 @@ strand = "Number & Algebra"
### 3. HTML and widgets
- Use shared classes: `book-prose`, `book-prose__heading`, `book-callout`, etc. Copy from `content/math/quadratic-equations/`.
- **Checkpoints:** `<details class="book-question">` with `book-question__prompt` and `book-question__solution` (not `__answer`). See `.agents/skills/ofb/math-chapter-patterns.md`.
- Put styles reused across several chapters in `content/{subject}/subject.scss`, not in each `chapter.scss`.
- **Do not** mention DSE, IB, or other curriculum names in chapter HTML.
- Mount widgets with `<div class="math-widget-mount" data-widget="widget-name" data-pagefind-ignore></div>` (filename without `.tsx` = `data-widget` value).
- **Math (KaTeX):** write `\( … \)` and `\[ … \]` in HTML; prose is auto-rendered on chapter load. In widgets use `import { renderLatex } from "@ofb/katex"` — do not add a per-widget `renderLatex` helper.
@ -131,7 +136,7 @@ zola serve
- `/math/your-chapter-slug/` — page renders.
- `bun run build` — full production build.
No theme edits, no `main.tsx` edits, no per-chapter template branches.
New subjects with shared CSS/JS: add `content/{subject}/subject.scss` and/or `subject.ts`; `sync:chapters` wires them automatically. No per-chapter template branches.
---