Skip to content

refactor: ♻️ generate README.md from qmd file #220

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.

Sign up for GitHub

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

Merged
lwjohnst86 merged 6 commits into from
May 18, 2026
Merged

refactor: ♻️ generate README.md from qmd file #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a22ee3
refactor: :recycle: generate README.md from qmd file
martonvago Apr 30, 2026
dcbb500
chore: :wrench: run just run-all
martonvago Apr 30, 2026
e4f7027
Revert "chore: :wrench: run just run-all"
martonvago May 1, 2026
5d09629
Merge branch 'main' into refactor/readme-generation
joelostblom May 7, 2026
0a6718a
Merge branch 'main' into refactor/readme-generation
martonvago May 15, 2026
22a24c4
refactor: :recycle: use default kernel
martonvago May 15, 2026
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
6 changes: 6 additions & 0 deletions template/README.md.jinja → template/README.qmd.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
format: gfm
execute:
echo: false
---

# {{ github_repo }}

<!-- TODO: Add a short description of the package and how to contribute. -->
Expand Down
6 changes: 5 additions & 1 deletion template/justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
just --list --unsorted

# Run all build-related recipes in the justfile
run-all: install-deps format-md format-python check-python check-spelling check-commits build build-website
run-all: install-deps format-md format-python check-python check-spelling check-commits build build-website build-readme

# List all TODO items in the repository
list-todos:
Expand Down Expand Up @@ -74,3 +74,7 @@ build-website: build-docs
# Preview the documentation website with automatic reload on changes
preview-website: build-docs
uv run quarto preview --execute

# Re-build the README file from the Quarto version
build-readme:
uvx --from quarto quarto render README.qmd --to gfm
Loading