Skip to content

Releases: open-physics-ed-org/open-physics-ed-org.github.io

Pocket Sand Edition (v2.0) 🚨🦸‍♂️🛠️

16 Jul 20:34
@dannycab dannycab
v2.0
585ebae

Choose a tag to compare

View all tags
Pocket Sand Edition (v2.0) 🚨🦸‍♂️🛠️ Latest
Latest

Pocket Sand Edition (v2.0) 🚨🦸‍♂️🛠️

A robust rebuild of OERForge, inspired by Dale Gribble’s legendary “Pocket Sand” move—quick, clever, and ready for anything. This release brings a modular design, helper libraries, and a fully documented, extensible codebase for open education.

🏗️ Highlights

  • Modular architecture: Each major function (build, convert, scan, export, verify, copy) is now a dedicated module with clear APIs.
  • Helper libraries: Streamlined content conversion, asset management, accessibility checking, and export workflows.
  • Robust error handling: Consistent logging and error management across all modules.
  • Accessibility: Integrated WCAG/Pa11y workflows for automated compliance checking and reporting.
  • Documentation: Every module is documented in Markdown for new users and contributors.
  • Extensibility: Easy to add new formats, workflows, and integrations.

🧩 Major Modules

  • build.py — Orchestrates the entire build workflow.
  • oerforge.convert — Converts Markdown, Jupyter, and DOCX to multiple formats.
  • oerforge.copyfile — Handles file and asset copying for deployment.
  • oerforge.db_utils — Manages the SQLite database for content and assets.
  • oerforge.export_all — Exports all site content and assets for backup or external use.
  • oerforge.make — Static site generator with Jinja2 templates and navigation.
  • oerforge.scan — Scans content and assets, populates the database.
  • oerforge.verify — Automated accessibility checking and badge/report generation.
  • pa11y.py — Batch runner for accessibility checks.

🚀 How to Use

  • See the documentation in content/documentation/ for API references and usage examples.
  • Run build.py to orchestrate the full site build.
  • Use pa11y.py for batch accessibility validation.

📄 License

See LICENSE in the project root.

Assets 2
Loading

Hank's Sturdy Build

09 Jul 21:18
@dannycab dannycab
v1.0
8345065

Choose a tag to compare

View all tags
Hank's Sturdy Build

Release v1.0: "Hank's Sturdy Build" 🏗️

🚀 Open Physics Education Network v1.0 — The Sturdy Foundation Release

We are proud to announce v1.0 of the Open Physics Education Network site generator! This release, named "Hank's Sturdy Build" (in honor of Hank Hill and the Texas spirit of reliability), marks the first stable version of our custom Python static site builder.

🎯 What's New in v1.0?

🐍 build.py: The Heart of the Site

  • Custom Static Site Generator: No Hugo, no Jekyll—just a handcrafted Python script that turns Markdown and YAML into a modern, accessible website.
  • YAML-Driven Structure: Reads _content.yml to define the site menu, structure, logo, and meta info.
  • Markdown to HTML: Converts all Markdown in content/ into simple and accessible HTML using templates in layouts/.
  • WCAG-Compliant & Accessible: Injects a modern, accessible theme, navigation, and logo into every page. Includes a dark/light mode toggle and keyboard navigation.
  • Smart Menu & Links: Dynamically generates the menu for every page, with correct relative links and ARIA roles for accessibility.
  • Asset Management: Copies CSS and images from static/ to docs/ automatically—no manual copying needed.
  • News & Previews: Special handling for news articles and index, with preview cards and summaries.
  • .nojekyll Support: Ensures GitHub Pages compatibility out of the box.
  • Debug Mode: Run with --debug for detailed output and troubleshooting.

📁 Output Structure

  • All output is in docs/, ready for GitHub Pages or any static host.
  • Homepage: docs/index.html
  • About: docs/about/index.html
  • News: docs/news/
  • CSS: docs/css/theme-modern.css
  • Images: docs/images/

📝 Documentation

  • See README.md for a friendly overview and quickstart.
  • See BUILD.md for a deep dive into the build process, file structure, and how to extend or debug the site.

💡 Why This Matters

  • Accessible by Design: Every page is built with accessibility and clarity in mind.
  • Open & Extensible: Anyone can add content, improve the build, or adapt the process for new courses.
  • Simple, Reliable, and Texas-Tough: Like Hank Hill, this build system is sturdy, dependable, and ready for the long haul.

This is just the beginning—let's build a more open, accessible future for physics education!

Loading

Hank's Solid Update (v1.0a)

09 Jul 22:38
@dannycab dannycab
v1.0a
2a55cab

Choose a tag to compare

View all tags
Hank's Solid Update (v1.0a)

Release v1.0a: "Hank's Solid Update" 🤠

🚀 Open Physics Education Network v1.0a — The Texas-Solid Update Release

We’re excited to announce v1.0a of the Open Physics Ed Static Site Generator! This release, named "Hank's Solid Update" (a nod to Hank Hill and the reliable, no-nonsense spirit of Texas), brings a set of practical improvements and workflow upgrades to our custom Python static site builder.

🎉 What's New in v1.0a?

This release brings a more robust, collaborative, and user-friendly build and deployment workflow for the Open Physics Education Network! Our static site generator is now easier to use, more accessible, and better documented for contributors and maintainers.

🛠️ Build & Workflow Improvements

  • VS Code Tasks: Added a new "Open Built Site" task for instant preview of your built site (docs/index.html) in your browser. No more manual navigation—just build and open!
  • .gitignore Updates: The .vscode and docs/ directories are now tracked in version control, making it easier for all contributors to share workspace settings and deploy the built site.
  • Consistent News Layout: News article headers now match the main site style for a unified, professional look and improved accessibility.
  • Cleaner Tasks: Removed user-specific and duplicate VS Code tasks for a streamlined contributor experience.

📚 Documentation & Release Management

  • Release Notes: This release statement is now versioned as RELEASE-v1.0a.md and stored in the repo for transparency and future reference.
  • Previous release notes have been moved to the releases/ directory for historical tracking.

🌟 Project Highlights

  • Accessible, open, and modern design
  • Collaborative development—anyone can contribute!
  • Simple, Python-based static site build system
  • Professional documentation and clear contribution guidelines

📝 How to Use

  1. Edit or add Markdown files in content/.
  2. Run the build task (Build Site) to generate the static site in docs/.
  3. Use the new Open Built Site task to preview your changes instantly.
  4. Commit and push both your content and the built site for deployment.

For more details, see the README, BUILD.md, and About pages.

Loading