Skip to content

Commit 5cd13b3

Browse files
committed
note on contributing
1 parent 2eca113 commit 5cd13b3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,16 @@ Authors are configured via `content/authors/`.
3636

3737
There are `Make` targets to get up and going, assuming you have the
3838
tooling required (Bun, prek, etc.)
39+
40+
### Writing Blog Entries
41+
42+
You can pull the repo, run `make dev`, and edit the page via Keystatic
43+
with the nice UI or you can write markdown in your editor.
44+
45+
Both should open a pull request to GitHub for review and CI checks.
46+
47+
> [!NOTE]
48+
> You have access to a few custom components that can be used like
49+
> `{% GhUser name="hugovk" /%}`, but PEPs, CPython docs, and GitHub links
50+
> will automatically be picked up if you use standard markdown via the
51+
> URL regex.

0 commit comments

Comments
 (0)