VARASYS/ZDDC-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ZDDC-website/README.md
ZDDC c275afc4a3 docs: add Publishing and Editing notes to README; stub CLAUDE.md 
Captures the rsync-on-push contract (excludes, delete-after) and the
two non-obvious editing constraints (layout.js selector list, inline
<style> convention). CLAUDE.md is now a one-line pointer to README so
/init has something to find.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 21:27:10 -05:00

2 KiB
Raw Blame History

ZDDC website

Hand-edited content for zddc.varasys.io. Two files:

  • index.html — landing page + install snippets.
  • reference.html — the ZDDC file-naming convention specification.

Plus css/, js/, img/ for shared styles and assets.

This repo intentionally does not contain release artifacts. The ZDDC tools (archive, transmittal, classifier, mdedit, landing) and the zddc-server binary are built from the source repo at https://codeberg.org/VARASYS/ZDDC and deployed to the live site by its build pipeline. They live on the deploy host under /srv/zddc/releases/, never in this repo's git history.

Preview locally

git clone https://codeberg.org/VARASYS/ZDDC-website
cd ZDDC-website
python3 -m http.server 8000
# open http://localhost:8000/

The preview won't have a /releases/ directory unless you also have the source repo and run its build pipeline. That's expected — the two repos are intentionally decoupled.

Publishing

.forgejo/workflows/deploy-content.yml rsyncs the working tree into /srv/zddc/ on the deploy host on every push to main. The rsync uses --delete-after and excludes /releases/, /.git*, /.forgejo*, /README.md, and /LICENSE — anything else added at the repo root will be published.

Editing notes

  • js/layout.js queries the header for .header-nav, .dropdown, .dropdown-toggle, .dropdown-menu, and .theme-toggle. Both HTML pages need to keep those classes or the theme toggle and Tools dropdown silently break.
  • Page-specific CSS goes in an inline <style> in <head> (see index.html); only shared rules go in css/style.css. Design tokens (--color-accent, spacing scale, etc.) live at the top of css/style.css — prefer those over hardcoded values.

Contributing

Issues + PRs welcome. For changes to the tool source code (not the website), file them at https://codeberg.org/VARASYS/ZDDC.

License

AGPL-3.0.