-
Notifications
You must be signed in to change notification settings - Fork 1
Report #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
maehr
wants to merge
5
commits into
eth-library:main
Choose a base branch
from
maehr:report
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Report #22
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8fc5b53
feat: add NAIF Typst report template
maehr 135b607
feat: expose NAIF Typst report as package
maehr dc33be8
feat: add Quarto NAIF report format
maehr 0611c78
refactor: move documents/templates to reports/templates
maehr dae1b5d
Merge remote-tracking branch 'upstream/main' into report
maehr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # NAIF report Quarto format | ||
|
|
||
| This Quarto extension exposes the NAIF Typst report template as the custom format | ||
| `naif-report-typst`. | ||
|
|
||
| ## Use | ||
|
|
||
| ```yaml | ||
| format: | ||
| naif-report-typst: | ||
| toc: true | ||
| number-sections: true | ||
| ``` | ||
|
|
||
| Common report metadata: | ||
|
|
||
| - `title` | ||
| - `subtitle` | ||
| - `authors` | ||
| - `date` | ||
| - `report-version` | ||
| - `abstract` | ||
| - `keywords` | ||
| - `doc-category` | ||
| - `compact-mode` | ||
| - `logo-path` | ||
|
|
||
| Render reports with the repository-managed Quarto command: | ||
|
|
||
| ```bash | ||
| uv run quarto render path/to/report.qmd | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| title: NAIF Report | ||
| author: NAIF team | ||
| version: "0.1.0" | ||
| quarto-required: ">=1.9.18" | ||
| contributes: | ||
| formats: | ||
| typst: | ||
| doc-category: "NAIF report" | ||
| website: "https://eth-library.github.io/naif/" | ||
| toc: true | ||
| number-sections: true | ||
| template-partials: | ||
| - typst-template.typ | ||
| - typst-show.typ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,70 @@ | ||||||
| #show: doc => naif-report( | ||||||
| $if(doc-category)$ | ||||||
| doc-category: [$doc-category$], | ||||||
| $endif$ | ||||||
| $if(title)$ | ||||||
| title: [$title$], | ||||||
| $endif$ | ||||||
| $if(subtitle)$ | ||||||
| subtitle: [$subtitle$], | ||||||
| $endif$ | ||||||
| $if(by-author)$ | ||||||
| authors: ( | ||||||
| $for(by-author)$ | ||||||
| $if(it.name.literal)$ | ||||||
| ( | ||||||
| name: [$it.name.literal$], | ||||||
| affiliation: [$for(it.affiliations)$$it.name$$sep$, $endfor$], | ||||||
| email: [$it.email$], | ||||||
|
||||||
| email: [$it.email$], | |
| email: "$it.email$", |
Copilot
AI
Apr 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The template passes Quarto’s project lang through to Typst (language: "$lang$"). In this repo _quarto.yml sets lang: en-UK, which is a non-standard BCP47 tag (typically en-GB). If Typst validates language tags, this can break rendering. Consider either omitting language unless explicitly set for the report, or normalising common values (e.g. mapping en-UK → en-GB).
Suggested change
| language: "$lang$", | |
| language: if "$lang$" == "en-UK" { "en-GB" } else { "$lang$" }, |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The extension config contributes settings under
formats.typst, but the documentation and example report use the custom format namenaif-report-typst. As written,format: naif-report-typst:will not be registered by this extension (unless Quarto implicitly aliases it), so the example render will fail. Align these by either defining the format underformats.naif-report-typst(and inheriting from Typst) or updating the docs/examples to useformat: typst:.