Skip to content

humanpred/pknca-site

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pknca-site

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).

Structure

_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.

Preview locally

quarto preview

Deploy

Deployment 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):

  1. Enable GitHub Pages. Settings → Pages → Source: GitHub Actions.
  2. 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/.

Custom domain (pknca.humanpredictions.com)

The CNAME file is committed and ready. To go live on the custom domain:

  1. Configure DNS at the humanpredictions.com registrar — add a CNAME record:

    pknca   CNAME   humanpred.github.io.
    
  2. Tell GitHub about the domain, either:

    • Settings → Pages → Custom domainpknca.humanpredictions.com (recommended for GitHub Actions deploys), or
    • uncomment the resources: [CNAME] block in _quarto.yml so the CNAME file is baked into every deploy.
  3. 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 the github.io URL. If you want to preview the deployed site before DNS is ready, enable Pages first and leave the custom domain unset until DNS resolves.

About

The website for PKNCA (including pknca-book and PKNCA)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors