ZDDC
21b357607d
All checks were successful
Deploy content to live site / deploy (push) Successful in 3s
We're consolidating ZDDC functionality into two tools rather than the four previously advertised. Transmittal Creator, Document Classifier, and Markdown Editor are removed from the public site; their workflows are absorbed into Browse (file-tree navigator with in-place markdown editing, on-demand DOCX/HTML/PDF download, file management surface for classification and transmittal preparation). Changes: - Dropdown menu (both index + reference): two entries (Archive Browser, Browse). - index.html "Try the tools": two tool cards. Hero + intro copy reflect the two-tool framing. - index.html "Install on your server": baked-in tool list collapses to archive + browse + index; the slash/no-slash routing convention is referenced rather than re-listing per-folder tool mappings. - index.html "Local: just download": two download links. - reference.html § 1 intro: "two tools" wording. - reference.html § 9 project layout: working/ description now points at the browse tool for markdown editing rather than the retired mdedit. - reference.html § 10 Tools: two cards with refreshed descriptions that match the consolidated scope. - README.md: tool list updated for new contributors. federal.html, css/, and js/ have no tool-product references to update; their "transmittal" mentions are the document-flow concept and stay as-is.
57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
# ZDDC website
|
|
|
|
Hand-edited content for [zddc.varasys.io](https://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`, `browse`, `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
|
|
|
|
```sh
|
|
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](LICENSE).
|