|
| 1 | +# JDF Landing Page |
| 2 | + |
| 3 | +Single-file static site for [JDF](https://github.com/uurtech/jdf), served from the `docs/` folder via GitHub Pages. |
| 4 | + |
| 5 | +## Structure |
| 6 | + |
| 7 | +``` |
| 8 | +docs/ |
| 9 | +├── index.html # Single-page landing |
| 10 | +├── style.css # Styling (light/dark mode auto) |
| 11 | +├── favicon.svg # Inline JDF logo |
| 12 | +├── _headers # Caching / security headers (used by Cloudflare-style hosts) |
| 13 | +└── .nojekyll # Disable Jekyll on GitHub Pages |
| 14 | +``` |
| 15 | + |
| 16 | +No build step, no framework, no JS dependency beyond a tiny inline `<script>` for the copy-to-clipboard button. |
| 17 | + |
| 18 | +## Local preview |
| 19 | + |
| 20 | +```bash |
| 21 | +cd docs |
| 22 | +python3 -m http.server 4000 |
| 23 | +# open http://localhost:4000 |
| 24 | +``` |
| 25 | + |
| 26 | +Any static file server works (`npx serve`, `caddy file-server`, etc.). |
| 27 | + |
| 28 | +## Deploy |
| 29 | + |
| 30 | +GitHub Pages serves directly from this folder. |
| 31 | + |
| 32 | +**One-time setup**: |
| 33 | +1. Repo → **Settings → Pages** |
| 34 | +2. **Build and deployment → Source**: `Deploy from a branch` |
| 35 | +3. **Branch**: `master`, **Folder**: `/docs` |
| 36 | +4. Save |
| 37 | + |
| 38 | +Every push to `master` that touches files under `docs/` is published automatically. The site lives at: |
| 39 | + |
| 40 | +- `https://uurtech.github.io/jdf/` |
| 41 | +- Or, if you set a custom domain in Pages settings (e.g. `jdf.uurtech.com`), at that domain after DNS propagates. |
| 42 | + |
| 43 | +For a custom domain, add a `CNAME` file with the host (single line) into this folder, and at the DNS provider: |
| 44 | + |
| 45 | +``` |
| 46 | +CNAME jdf uurtech.github.io. |
| 47 | +``` |
| 48 | + |
| 49 | +GitHub issues a Let's Encrypt cert automatically once DNS resolves. |
| 50 | + |
| 51 | +## Author |
| 52 | + |
| 53 | +[Ugur Kazdal](https://uurtech.com) · [@uurtech](https://github.com/uurtech) |
0 commit comments