From 5bb576116eb123785968b34c307b23aecaa1110c Mon Sep 17 00:00:00 2001 From: Derek Cooper Date: Sat, 14 Mar 2026 08:20:43 -0700 Subject: [PATCH] updated with shortcode preferences --- preferences/articles.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/preferences/articles.md b/preferences/articles.md index 0e7c5c8..201194c 100644 --- a/preferences/articles.md +++ b/preferences/articles.md @@ -159,13 +159,28 @@ Use `---` to separate major logical sections when needed. --- +## Shortcodes + +### `remote-code` — Embed code from Gitea +Use instead of pasting a static code block when the file lives in Gitea. + +``` +{{}} +``` + +- URL must use the `raw/branch/main/...` path on `git.chns.tech` +- Use `lang="yaml"` for Docker Compose files +- Always follow with an explanation of what the file does and what values to change + +--- + ## Docker App Post Template Most common post type. Structure: 1. **Introduction** — what the app does, why the author uses/likes it 2. **Prerequisites** — linked list of required background posts -3. **Deployment** — Docker Compose YAML in a code block, then explanation +3. **Deployment** — Docker Compose via `remote-code` shortcode (linking to Gitea), then explanation of what to change 4. **Configuration** — step-by-step GUI or config walkthrough with screenshots 5. **Feature sections** — one `##` section per major feature (e.g., "## Create Recipe", "## Import Recipes") 6. **Conclusion** — personal thoughts, link to official docs/GitHub @@ -201,5 +216,4 @@ services: - Use overly formal or corporate language - Skip explaining what a code block does - Write in passive voice -- Leave readers without context on why something matters -- Use Hugo shortcodes (none are currently used) \ No newline at end of file +- Leave readers without context on why something matters \ No newline at end of file