How monapdx/modular-markup works
1. What this repo is
- Modular Markup is a static collection of browser-based HTML tools.
- The core architectural idea is: each tool is a self-contained HTML template that behaves like a lightweight app in the browser.
2. Primary runtime boundary
- There is no backend service, database, or account system.
- The entire runtime boundary is the user’s browser: templates load locally, accept edits, and persist state client-side.
3. Main content layer
- The actual product surface is in docs/TEMPLATES/.
- This directory contains the reusable HTML tools such as:
- EXPENSES.html
- LOG.html
- PROGRESS.html
- PROJECT.html
- QUOTE_LOG.html
- SYMPTOMS.html
- TASKS.html
- blank-tables.html
- knowledge-map.html
- health.html
- movies.html
- sandbox.html
- These files are the core “modules” of the system.
4. Template-first architecture
- Each HTML file is a standalone template designed to be edited and remixed.
- The repo emphasizes editable structure rather than fixed views:
- tables are editable
- headers/categories can be changed
- rows can be added or deleted
- layouts can be customized
5. Persistence flow
- User edits are saved in LocalStorage inside the browser.
- The data flow is:
- open HTML template
- edit content in-browser
- automatic local save
- reopen later and restore prior state
- This means persistence is device/browser-local, not shared or server-synced.
6. Export/restore flow
- A key interaction boundary is the ability to:
- Export This Version
- Restore Default
- Export turns the customized browser state into a standalone HTML file.
- That exported file becomes a portable artifact that carries the user’s edits without needing the original repo or any service.
7. Static assets and documentation
- assets/ holds supporting media, especially screenshots and GIFs used in documentation and README examples.
- The README functions as the main product documentation and showcases the templates as working tools, not mockups.
8. Hosting/deployment
- .github/workflows/pages.yml indicates the repo is deployed through GitHub Pages.
- That suggests the repo is distributed as a static site, likely serving the HTML templates directly from the repository contents.
9. Repo organization vs. product organization
- .github/ISSUE_TEMPLATE/ contains issue forms for requests, suggestions, and contributions.
- This is the project’s community intake layer, not part of the runtime app.
- It supports adding templates, resources, patterns, or reporting issues.
10. Documentation/template packaging
- docs/TEMPLATES/ also contains items like STARTER.zip, _patch_export_snapshot.py, and CSS files such as neo-brutalist.css and neo-brutal-overrides.css.
- This suggests a packaging/export-oriented workflow around the templates, with styling and snapshot/export support bundled alongside the HTML files.
11. UI/style system
- The visible design system is likely centered on the bundled CSS files in docs/TEMPLATES/.
- The templates appear to share a consistent “neo-brutalist” presentation layer, which is a styling boundary across multiple tools rather than a shared backend component.
12. Best diagram framing
- If you draw this repo, model it as:
- GitHub Pages static host
- serving standalone HTML templates
- styled by shared CSS/assets
- with browser-local persistence via LocalStorage
- and an export path that produces portable HTML copies.
Main entry points: index.html Template index · neo-brutalist.css Neo CSS · EXPENSES.html Expenses · LOG.html Log
Components 19
Hosting
Static delivery and deployment boundary.
- Pages deploy · Build/deploy path for publishing the static site.
.github/workflows/pages.yml - Static site · Public static delivery surface for the repository.
Template Library
Browser-editable HTML tools and entry points.
- Template index · Landing page that surfaces the browser tools.
docs/TEMPLATES/index.html - Expenses · Standalone editable HTML template.
docs/TEMPLATES/EXPENSES.html - Log · Standalone editable HTML template.
docs/TEMPLATES/LOG.html - Progress · Standalone editable HTML template.
docs/TEMPLATES/PROGRESS.html - Project · Standalone editable HTML template.
docs/TEMPLATES/PROJECT.html - Tasks · Standalone editable HTML template.
docs/TEMPLATES/TASKS.html - Knowledge map · Standalone editable HTML template.
docs/TEMPLATES/knowledge-map.html - Other templates · Additional browser tools and starter pages bundled with the library.
Browser Runtime
Client-side persistence and export behavior inside the user’s browser.
- LocalStorage · Browser-local saved state for edited templates.
- Exported HTML · Standalone HTML copy produced from customized browser state.
Styling & Packaging
Shared presentation, export helpers, and bundled artifacts.
- Neo CSS · Common neo-brutalist presentation layer.
docs/TEMPLATES/neo-brutalist.css - Style overrides · Template-specific visual overrides.
docs/TEMPLATES/neo-brutal-overrides.css - Export helper · Snapshot/export support used around template packaging.
docs/TEMPLATES/_patch_export_snapshot.py - Starter pack · Packaged starter archive distributed with templates.
docs/TEMPLATES/STARTER.zip
Docs & Media
Repository documentation and visual examples.
Community Intake
Issue templates for requests and submissions.
- Issue forms · Contribution and request forms for templates, resources, and patterns.
.github/ISSUE_TEMPLATE/add-template.yml
Connections 28
- Pages deploy → Static site: deploys · Publishes the repository as a static site.
- Static site → Template index: serves · Entry point to the template library.
- Template index → Expenses: opens · Links to a representative editable tool.
- Template index → Log: opens · Links to a representative editable tool.
- Template index → Progress: opens · Links to a representative editable tool.
- Template index → Project: opens · Links to a representative editable tool.
- Template index → Tasks: opens · Links to a representative editable tool.
- Template index → Knowledge map: opens · Links to a representative editable tool.
- Template index → Other templates: groups · Covers the remaining bundled template pages.
- Expenses → LocalStorage: saves · Template edits persist in browser-local storage.
- Log → LocalStorage: saves · Template edits persist in browser-local storage.
- Progress → LocalStorage: saves · Template edits persist in browser-local storage.
- Project → LocalStorage: saves · Template edits persist in browser-local storage.
- Tasks → LocalStorage: saves · Template edits persist in browser-local storage.
- Knowledge map → LocalStorage: saves · Template edits persist in browser-local storage.
- LocalStorage → Exported HTML: exports · Saved state can be rendered into a portable HTML file.
- Export helper → Exported HTML: builds · Supports snapshot/export packaging.
- Neo CSS → Expenses: styles · Shared presentation layer used by templates.
- Neo CSS → Log: styles · Shared presentation layer used by templates.
- Neo CSS → Progress: styles · Shared presentation layer used by templates.
- Neo CSS → Project: styles · Shared presentation layer used by templates.
- Neo CSS → Tasks: styles · Shared presentation layer used by templates.
- Neo CSS → Knowledge map: styles · Shared presentation layer used by templates.
- Style overrides → Template index: styles · Overrides the shared template presentation.
- Starter pack → Other templates: packages · Bundled starter/archive material for remixing templates.
- README → Template index: documents · Shows the templates as the main product surface.
- README → Media: illustrates · Uses screenshots and GIFs to demonstrate the tools.
- Issue forms → Other templates: requests · Community intake for new templates and related contributions.