The hub landing page for PKNCA — layer 3 of the three-layer documentation structure (modeled on mrgsolve.org):
| Layer | Repo | URL |
|---|---|---|
| 1 — pkgdown function reference | humanpred/pknca |
https://humanpred.github.io/pknca/ |
| 2 — Quarto user-guide book | humanpred/pknca-book |
https://humanpred.github.io/pknca-book/ |
| 3 — hub landing page | humanpred/pknca-site (this repo) |
https://pknca.humanpredictions.com |
This repo is a Quarto website (not a book). It renders index.qmd and
news.qmd into a small landing site whose navbar links out to the user guide
(layer 2) and the function reference (layer 1).
_quarto.yml # website config + navbar
index.qmd # landing page
news.qmd # changelog (includes NEWS.md)
NEWS.md # snapshot of humanpred/pknca NEWS.md (refreshed by CI)
CNAME # custom domain (see "Custom domain" below)
.github/workflows/site.yml # render + deploy to GitHub Pages
news.qmd includes NEWS.md. A committed snapshot keeps local previews
working; the deploy workflow re-fetches the latest NEWS.md from
humanpred/pknca@main before each render so the published changelog stays
current.
quarto previewDeployment is automated by .github/workflows/site.yml (render with Quarto,
publish via GitHub Pages) on every push to main.
One-time setup (not yet done — requires repo admin / DNS access):
- Enable GitHub Pages. Settings → Pages → Source: GitHub Actions.
- Push
main. The workflow renders and deploys the site. With Pages on but no custom domain yet, it is served at https://humanpred.github.io/pknca-site/.
The CNAME file is committed and ready. To go live on the custom domain:
-
Configure DNS at the
humanpredictions.comregistrar — add aCNAMErecord:pknca CNAME humanpred.github.io. -
Tell GitHub about the domain, either:
- Settings → Pages → Custom domain →
pknca.humanpredictions.com(recommended for GitHub Actions deploys), or - uncomment the
resources: [CNAME]block in_quarto.ymlso theCNAMEfile is baked into every deploy.
- Settings → Pages → Custom domain →
-
Wait for DNS to propagate, then enable "Enforce HTTPS" in Settings → Pages.
site-url in _quarto.yml is already set to
https://pknca.humanpredictions.com. Until the domain is live, browse the
site at the github.io URL above.
Ordering note: once the custom domain is active, GitHub Pages serves the site only at
pknca.humanpredictions.com, not at thegithub.ioURL. If you want to preview the deployed site before DNS is ready, enable Pages first and leave the custom domain unset until DNS resolves.