From 54504f5ac26252379668032e8ea05ae51ae16e4a Mon Sep 17 00:00:00 2001 From: wompmacho Date: Sun, 12 Apr 2026 06:35:42 +0000 Subject: [PATCH] Updated the Gitea Action to mount the framework at its actual path --- .gitea/workflows/deploy.yaml | 4 +- projects/hugo/hugo-project-main.md | 10 ++++ projects/hugo/hugo_shortcodes.md | 83 ++++++++++++++++++++++++++++++ 3 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 projects/hugo/hugo-project-main.md create mode 100644 projects/hugo/hugo_shortcodes.md diff --git a/.gitea/workflows/deploy.yaml b/.gitea/workflows/deploy.yaml index 18f529f..09f5e6a 100644 --- a/.gitea/workflows/deploy.yaml +++ b/.gitea/workflows/deploy.yaml @@ -10,7 +10,7 @@ jobs: container: image: hugomods/hugo:latest # Mount deployment target and the framework directly from the host - options: --user root -v /srv/www:/srv/www -v /srv/dev/hugo/wiki:/framework:ro -v /srv/configs:/srv/configs:ro + options: --user root -v /srv/www:/srv/www -v /srv/dev/hugo/wiki:/srv/dev/hugo/wiki:ro -v /srv/configs:/srv/configs:ro steps: - name: Checkout Docs Source @@ -27,7 +27,7 @@ jobs: DOCS_DIR=$(pwd) # Copy the read-only framework to a writable build directory - cp -r /framework /tmp/hugo-build + cp -r /srv/dev/hugo/wiki /tmp/hugo-build cd /tmp/hugo-build # Remove the symlinks that were copied from the host diff --git a/projects/hugo/hugo-project-main.md b/projects/hugo/hugo-project-main.md new file mode 100644 index 0000000..8537ced --- /dev/null +++ b/projects/hugo/hugo-project-main.md @@ -0,0 +1,10 @@ +--- +title: "Hugo" +description: "Personal Site Dev workflow." +author: wompmacho +date: '2025-03-30' +lastmod: '2025-03-30' +tags: [hugo, framework, overview, documentation] +--- + +{{< include "/srv/dev/hugo/wiki/README.md" >}} \ No newline at end of file diff --git a/projects/hugo/hugo_shortcodes.md b/projects/hugo/hugo_shortcodes.md new file mode 100644 index 0000000..f819b21 --- /dev/null +++ b/projects/hugo/hugo_shortcodes.md @@ -0,0 +1,83 @@ +--- +author: wompmacho +tags: [] +title: Hugo Special Markdown Codes +description: Available Shortcodes, and other resources for configuration. +date: '2025-03-27' +lastmod: '2025-03-28' +--- + +## Available Shortcodes + +### Project Shortcodes + +Custom shortcodes defined in `layouts/shortcodes/`. + +* **`include`**: Include a Markdown file into another. Supports absolute paths (mapped to `private/`) and relative paths (relative to Hugo content). + * Usage: `{{/* include "private/bazel/plan.md"*/}}` or `{{/* include "/srv/docs/private/bazel/plan.md"*/}}` +* **`video`**: Embed local or remote videos. + * Usage: `{{/* video src="path/to/video.mp4"*/}}` +* **`rawhtml`**: Insert raw HTML content. + * Usage: `{{/* rawhtml*/}}
Your HTML here
{{/* /rawhtml*/}}` + +### Theme Shortcodes (Blowfish) +Commonly used shortcodes from the [Blowfish theme](https://blowfish.page/docs/shortcodes/). + +* **`alert`**: Display a callout/alert box. + * Usage: `{{/* alert icon="circle-info"*/}}Your message here.{{/* /alert*/}}` +* **`badge`**: Display a small badge. + * Usage: `{{/* badge*/}}New{{/* /badge*/}}` +* **`icon`**: Display an icon from the theme's icon set. + * Usage: `{{/* icon "github"*/}}` +* **`button`**: Create a styled button. + * Usage: `{{/* button href="https://google.com" target="_self"*/}}Click Me{{/* /button*/}}` +* **`mermaid`**: Render Mermaid.js diagrams. + * Usage: `{{/* mermaid*/}}graph TD; A-->B;{{/* /mermaid*/}}` +* **`timeline`**: Create a vertical timeline. + * Usage: `{{/* timeline*/}}{{/* timelineItem ...*/}}{{/* /timeline*/}}` + +--- + +## Markdown Callouts (Admonitions) + +We use `hugo-admonitions` which follows the [GitHub/Obsidian alert syntax](https://github.com/orgs/community/discussions/16925). + +### Basic Syntax + +```markdown +> [!TYPE] Title (Optional) +> Content here. +``` + +### Foldable Callouts + +Use `+` for expanded by default or `-` for collapsed. +```markdown +> [!TYPE]+ Foldable Title +> This callout is expanded by default. +``` + +### Supported Types + +The following types are mapped to specific icons and colors: + +| Type | Icon | Description | +| :---------- | :-------------- | :---------------------------------------- | +| `note` | Pen | General information (default). | +| `abstract` | Lines | Summaries or abstracts. | +| `info` | Info Circle | Informational notes. | +| `tip` | Lightbulb | Helpful tips or suggestions. | +| `success` | Check Circle | Successful outcomes or "done" states. | +| `question` | Question Circle | Questions or areas needing clarification. | +| `warning` | Triangle Excl. | Warnings to pay attention to. | +| `failure` | X Circle | Failed outcomes. | +| `danger` | Triangle Excl. | Critical warnings. | +| `bug` | Bug | Known issues or bugs. | +| `example` | Teacher | Examples and use cases. | +| `quote` | Quote | Important quotes. | +| `important` | Excl. Circle | Critical information. | +| `caution` | Triangle Excl. | Use with caution. | +| `todo` | List Check | Tasks or items to be done. | +| `hint` | Lightbulb | Hints or clues. | + +--- \ No newline at end of file