updated with shortcode preferences
This commit is contained in:
@@ -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.
|
||||
|
||||
```
|
||||
{{</* remote-code url="https://git.chns.tech/CHNS/Docker-Compose/raw/branch/main/AppName/docker-compose.yaml" lang="yaml" */>}}
|
||||
```
|
||||
|
||||
- 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
|
||||
@@ -202,4 +217,3 @@ services:
|
||||
- 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)
|
||||
Reference in New Issue
Block a user