Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,18 @@ Thanks for considering a contribution.
For tagged releases, also run `npm run release:prepare -- --tag vX.Y.Z` and commit the generated
archive before publishing the release so Zenodo captures the rendered site snapshot.

## Quarto builds

Use the npm scripts or call Quarto through `uv run`; do not call `quarto` directly.

| Task | npm script | Direct Quarto command | Configuration |
| --------------------- | --------------------- | ------------------------------------- | -------------------------------------------- |
| Render the website | `npm run render` | `uv run quarto render` | `_quarto.yml` |
| Preview the website | `npm run preview` | `uv run quarto preview` | `_quarto.yml` |
| Render with fork URLs | `npm run render:fork` | `uv run quarto render --profile fork` | `_quarto.yml` + untracked `_quarto-fork.yml` |
| Export DOCX | `npm run docx` | `uv run quarto render --profile docx` | `_quarto.yml` + `_quarto-docx.yml` |
| Render poster PDFs | `npm run pdf` | `uv run quarto render --profile pdf` | `_quarto.yml` + `_quarto-pdf.yml` |

## Content contributions

- Blog entries must follow the folder-per-entry structure described in `AGENTS.md`.
Expand Down
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,24 @@ This repository includes a dedicated Quarto profile in `_quarto-docx.yml`.

```bash
npm run docx
# or: uv run quarto render --profile docx
```

Output file:

- `_site-docx/NAIF-Website-Export.docx`

### Render all posters to PDF

This repository includes a dedicated Quarto profile in `_quarto-pdf.yml`.

```bash
npm run pdf
# or: uv run quarto render --profile pdf
```

Poster PDFs are written next to each poster source, for example `posters/<entry>/poster.pdf`.

### Validate before opening a PR

Run all checks (formatting, linting, type checking, tests, render, rendered link checks) in one go:
Expand Down Expand Up @@ -97,8 +109,24 @@ Zenodo will archive.
| `npm run preview` | `uv run quarto preview` | Local dev server with live reload |
| `npm run preview:fork` | `uv run quarto preview --profile fork` | Preview locally with fork-specific URLs |
| `npm run docx` | `uv run quarto render --profile docx` | Export site to a single DOCX |
| `npm run pdf` | `uv run quarto render --profile pdf` | Render all poster sources to PDF |
| `npm run site:build` | `render` + `jampack` | Build the optimised release site |

#### Quarto configuration files

| File | Used by | Purpose |
| -------------------------- | ----------------------------------- | ------------------------------------------------------------- |
| `_quarto.yml` | `npm run render`, `npm run preview` | Main website configuration and shared HTML rendering settings |
| `_quarto-docx.yml` | `npm run docx` | DOCX export profile for site pages, posts, and events |
| `_quarto-pdf.yml` | `npm run pdf` | PDF export profile for all poster sources under `posters/**` |
| `_quarto-fork.yml.example` | Manual template | Template for local fork-specific URLs |
| `_quarto-fork.yml` | `--profile fork` commands | Untracked local fork overrides; copy from the example file |
| `posters/**/_quarto.yml` | Individual poster directories | Standalone `docposter` configuration for rendering one poster |

Always invoke Quarto through `uv run`, either directly or via the npm scripts above. Quarto profiles
are selected with `--profile <name>`, which makes Quarto merge `_quarto-<name>.yml` into the base
configuration for that command.

#### Code quality

| Script | Command | Description |
Expand Down
21 changes: 21 additions & 0 deletions _quarto-pdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
project:
type: default
render:
- "!about.qmd"
- "!disclaimer.qmd"
- "!index.qmd"
- "!llms.qmd"
- "!publishing-guidelines.qmd"
- "!team.qmd"
- "!dashboards/**"
- "!events/**"
- "!mentions/**"
- "!posts/**"
Comment thread
maehr marked this conversation as resolved.
Outdated
- "!posters/index.qmd"
post-render:
- _extensions/bbucior/docposter/R/chrome_pdf.R

format:
docposter-html:
fill-page: true
embed-resources: true
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"release:prepare": "npm run site:build && npm run site:archive -- --stage",
"render": "uv run quarto render",
"render:fork": "uv run quarto render --profile fork",
"pdf": "uv run quarto render --profile pdf",
"screenshot:clean": "node scripts/screenshot-clean.mjs",
"screenshot:install-browsers": "npx playwright install chromium",
"site:archive": "uv run python scripts/release_site_archive.py",
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Binary file not shown.
Binary file not shown.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Setting up the default project metadata for `quarto use`
# per https://quarto.org/docs/extensions/project-types.html#project-type-extension

project:
title: "DARIAH poster"
title: "DARIAH Annual Event 2026 Poster"
type: docposter
post-render:
# Also convert the poster html output to pdf.
# Comment out this chrome_pdf.R step if only the html output is desired.
- _extensions/bbucior/docposter/R/chrome_pdf.R

format:
Expand Down
Loading
Loading