Skip to content

Commit b184279

Browse files
committed
chore: add _quarto.yml for GFM YAML preservation and document blog md sync
Made-with: Cursor
1 parent 071a175 commit b184279

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,37 @@ dependencies and activate it.
8282
- Run `makim pages.build` to render `index.qmd` to `index.md` and build the
8383
site. The generated `index.md` is used to render the webpage.
8484

85+
### Regenerating blog Markdown (for CI)
86+
87+
CI expects the rendered `index.md` files under `pages/blog/*/` to be committed.
88+
If you change `.qmd` content or metadata, regenerate and push the markdown:
89+
90+
```bash
91+
# From repo root with conda env active (e.g. on WSL or Linux)
92+
$ makim pages.pre-build
93+
$ git add pages/blog/*/index.md
94+
$ git commit -m "chore: sync rendered blog index.md from qmd"
95+
$ git push
96+
```
97+
98+
On Windows, use WSL or a Linux environment so `makim pages.pre-build` (Quarto) runs correctly.
99+
100+
### Commit messages
101+
102+
Keep commit messages professional and descriptive. Do not add tool or editor tags
103+
(e.g. "Made-with: Cursor") to commit messages.
104+
105+
To fix existing commits that contain such a line (e.g. before pushing a PR):
106+
107+
```bash
108+
# Rebase the last N commits (replace 3 with how many need fixing)
109+
$ git rebase -i HEAD~3
110+
# In the editor, change 'pick' to 'reword' for each commit whose message you want to fix. Save and close.
111+
# For each chosen commit, Git will open the message: remove the "Made-with: ..." line, save and close.
112+
# Then force-push your branch (only for your own PR branch):
113+
$ git push --force-with-lease
114+
```
115+
85116
## Final Steps
86117

87118
Before submitting your blog post:

_quarto.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Project-level Quarto config. Ensures GFM output keeps YAML front matter
2+
# so blog index.md have title, date, authors, tags, etc. for MkDocs.
3+
format:
4+
gfm:
5+
variant: +yaml_metadata_block

0 commit comments

Comments
 (0)