opencode-skills-collection 3.1.12 → 3.1.13

package/bundled-skills/hugo-to-markdown/references/front-matter-and-content.md

@@ -0,0 +1,145 @@
+# Front Matter And Content Rules
+
+## Front Matter Policy
+
+Default to YAML front matter in the output unless the user explicitly asks to strip metadata.
+
+Preserve fields when they still carry meaning in the destination:
+
+- `title`
+- `linkTitle`
+- `description`
+- `date`
+- `publishDate`
+- `lastmod`
+- `expiryDate`
+- `draft`
+- `aliases`
+- `slug`
+- `url`
+- `weight`
+- `categories`
+- `keywords`
+- `params`
+- `menus` or menu-like data
+
+Do not invent fields that were not present.
+
+If the repository mixes casing for reserved Hugo fields, normalize to the documented canonical form in the output:
+
+- `Title` -> `title`
+- `Description` -> `description`
+- `LinkTitle` -> `linkTitle`
+
+Apply this normalization before using front matter to build lists, tables, or link labels. Preserve unknown custom keys with their original spelling unless the user asks for a schema rewrite.
+
+## Effective Value Rules
+
+Do not treat front matter as a flat key-value copy problem. In Hugo, some visible values are inferred from configuration, aliases, filenames, or Git metadata.
+
+For the source site, check any site-specific front matter documentation and the local `[frontmatter]` config before deciding which value is authoritative.
+
+Important alias rules:
+
+- `publishDate` can come from `publishdate`, `pubdate`, or `published`
+- `lastmod` can come from `lastmod` or `modified`
+- `expiryDate` can come from `expirydate` or `unpublishdate`
+
+Important token rules:
+
+- `:default` means Hugo falls back through the documented default date sequence
+- `:filename` can derive `date` and sometimes `slug` from a date-prefixed filename
+- `:fileModTime` can supply a date from the file modification time
+- `:git` can supply a date from Git history when enabled
+
+Conversion guidance:
+
+- Preserve explicit source fields when they are already concrete and meaningful.
+- If the repository relies on alias or token resolution, do not mistakenly drop related metadata just because the canonical key is absent.
+- If you can deterministically resolve a derived date or slug from the local snapshot and the user wants flattened output, materialize it explicitly.
+- If deterministic resolution would require Git state, build execution, or missing metadata, keep the source field plus a short conversion note instead of guessing.
+
+## Resources Metadata
+
+Front matter may also describe page resources, not just page metadata.
+
+Preserve `resources` metadata when it affects:
+
+- image or file labels
+- resource lookup by `Name`
+- titles used in generated link text
+- custom `params`
+- wildcard-driven assignments
+
+In Hugo's page resource rules, matching order matters and `name` and `title` can use the `:counter` placeholder. Do not simplify these structures away unless the destination explicitly does not need them.
+
+## Archetype Signal
+
+Read archetypes before normalizing front matter. In a typical Hugo docs site:
+
+- `archetypes/default.md` establishes the common fields
+- `archetypes/functions.md` adds nested `params.functions_and_methods`
+- `archetypes/methods.md` follows the same method metadata pattern
+- `archetypes/glossary.md` and `archetypes/news.md` introduce content-type-specific fields
+
+When an archetype or local content convention introduces nested fields, preserve the shape unless the user asks for a simplified schema.
+
+## Content Composition Rules
+
+The page file is not always the full source of truth. Also check:
+
+- shared `_common` content fragments
+- shortcode-generated prose
+- data-backed shortcode inputs from `data/*`
+- generated example source files referenced by local shortcodes
+- render-hook-driven link behavior
+- page bundle resources and section resources
+- page resource metadata from the page's own front matter
+- front matter configuration that changes how dates, slugs, and publish status are derived
+
+## Literal Examples Versus Live Syntax
+
+Preserve literal Hugo examples when they are:
+
+- inside fenced code blocks
+- clearly escaped with comment markers such as `/* ... */`
+- part of tutorial prose explaining Hugo syntax
+
+Important escaped forms to preserve:
+
+- `{{</* foo */>}}`
+- `{{%/* foo */%}}`
+- notation examples that compare `%` and `<` shortcode forms in tables or inline code
+
+Do not treat those as active shortcode invocations merely because they are outside fenced code blocks.
+
+Convert live syntax when it changes the rendered page.
+
+## Explicit Downgrade Policy
+
+When a local shortcode cannot be materialized safely:
+
+- remove the live Hugo syntax
+- replace it with a short Markdown explanation
+- keep any safe subset of content that is already visible in the page source
+
+Examples:
+
+- preserve inline Redis CLI text even if a multi-language tabset cannot be rebuilt
+- preserve a resolved image URL even if the surrounding presentation wrapper is custom
+- preserve section purpose and emit a note if a build-time data table cannot be reconstructed
+
+## Markdown Features To Preserve
+
+Keep these when possible:
+
+- fenced code blocks
+- tables
+- blockquotes
+- definition lists if the destination Markdown flavor supports them
+- math passthrough delimiters when the destination supports math
+- block attributes only when the destination flavor supports them
+- heading attributes such as `## Heading {#id .class}`
+- code fence attributes and highlighting options when the destination flavor supports them
+
+If the destination does not support a feature, downgrade explicitly instead of dropping content.

package/bundled-skills/hugo-to-markdown/references/links-assets-and-validation.md

@@ -0,0 +1,106 @@
+# Links, Assets, And Validation
+
+## Link Resolution
+
+Treat link resolution as repository-specific behavior.
+
+For a typical Hugo docs site:
+
+- internal links may be plain Markdown destinations
+- `ref` and `relref` appear in docs examples and sometimes in live content
+- the custom link render hook resolves pages, page resources, section resources, and global resources
+- broken-link behavior is controlled by config and local render-hook logic
+- glossary shorthand may appear as a Markdown destination exactly equal to `(g)`
+- fragments may be validated against target headings rather than passed through blindly
+
+### Resolution Order
+
+For a custom `render-link.html`, the typical resolution order is:
+
+1. content page
+2. page resource from the current page bundle
+3. section resource from the current section when the page is not a leaf bundle
+4. global resource from `assets`
+
+Implications for conversion:
+
+- do not assume every relative link targets a page
+- do not treat page bundle files and section bundle files as interchangeable
+- do not preserve `/en/` filesystem paths when the site mounts `content/en` to logical `content`
+- preserve query strings and fragments when they still resolve after flattening
+- if fragment validity cannot be confirmed from the local snapshot, keep the fragment but add a note only when there is real ambiguity
+
+When converting:
+
+- resolve internal destinations to ordinary Markdown links
+- keep remote links as normal external links
+- preserve fragments when they still point to stable headings
+- avoid copying unresolved Hugo link functions into the output
+- if a generated table or list uses front matter fields for labels, resolve those fields case-insensitively before emitting the final Markdown
+
+## Assets
+
+Check all of these before rewriting image or file references:
+
+- page bundle resources
+- section resources
+- mounted assets
+- static files
+
+For Hugo repositories, also distinguish:
+
+- leaf bundles versus branch bundles
+- page resources of type `page` versus image, data, document, or video resources
+- resource metadata defined in front matter under `resources`
+
+For sites with custom link render hooks, the hook may explicitly rely on assets and mounted resources. Read `hugo.toml` and `layouts/_markup/render-link.html` before changing asset paths.
+
+### Bundle-Aware Rules
+
+Use the official page bundle and page resource docs as conversion constraints:
+
+- files next to `index.md` in a leaf bundle can be page resources and may not be rendered as standalone pages
+- files under a branch bundle can be descendant content pages or non-page resources depending on placement
+- section resource lookup is invalid for leaf bundles in the local render-link logic
+- resource `Name`, `Title`, and `params` can come from front matter metadata rather than filename alone
+
+If a shortcode or render hook references a resource, check whether the destination depends on bundle type before flattening the path.
+
+## Validation Checklist
+
+Run:
+
+```bash
+python3 skills/hugo-to-markdown/scripts/check_standard_markdown.py \
+  --root /path/to/output
+```
+
+Review hits for:
+
+- active `{{< ... >}}` or `{{% ... %}}`
+- active Go template expressions such as `{{ if ... }}` or `{{ .Page ... }}`
+- Hugo-specific link helpers left in prose
+- leaked local absolute paths
+- executable HTML or script residue that should have been downgraded
+- empty Markdown links or table cells caused by front matter key mismatches
+- missing downgrade notes where content was stripped but not materialized
+
+## Residue Triage
+
+If the validator reports a construct:
+
+1. Check whether it is inside a fenced code block.
+2. Check whether it is an escaped literal example such as `{{</* foo */>}}` or `{{%/* foo */%}}` in prose or a notation table.
+3. If it is a literal example, keep it.
+4. If it is active Hugo syntax, resolve or rewrite it.
+5. If it cannot be resolved safely, replace it with explicit Markdown text explaining the original behavior.
+
+## Downgrade Review
+
+After conversion, manually inspect each explanatory note you introduced:
+
+- verify that the original shortcode syntax is gone
+- verify that the note still tells the reader what was omitted
+- verify that any safe subset, such as inline code, resolved links, or image URLs, was preserved
+
+The goal is standard Markdown with explicit loss reporting, not silent truncation.

package/bundled-skills/hugo-to-markdown/references/shortcodes-and-render-hooks.md

@@ -0,0 +1,281 @@
+# Shortcodes And Render Hooks
+
+## Shortcode Notation
+
+Hugo has two shortcode notations:
+
+- `{{< ... >}}`
+- `{{% ... %}}`
+
+Use Hugo's rule, documented in the official shortcode pages:
+
+- `%` notation is rendered before Markdown
+- `<` notation is rendered after Markdown
+
+For conversion, do not preserve this live syntax in the final standard Markdown unless the document is explicitly teaching Hugo syntax.
+
+## Shortcode Calling Rules
+
+Before rewriting a shortcode, determine all of these:
+
+1. embedded, custom, or inline
+2. opening/closing block form, self-closing form, or both
+3. named arguments, positional arguments, or both
+4. whether mixed named and positional arguments are forbidden
+5. whether the shortcode must be called with `%` notation or `<` notation
+
+These are not cosmetic details. They can change visible output, table-of-contents behavior, and whether inner Markdown is rendered at all.
+
+Important Hugo rules from the official shortcode docs:
+
+- inline shortcodes are a separate feature and are disabled unless explicitly enabled
+- some shortcodes require body content, some forbid it, and some support both forms
+- named arguments are case-sensitive
+- named and positional arguments cannot be mixed within one shortcode call
+- multiline arguments and raw string literals are valid shortcode syntax
+- nested shortcodes are allowed except for inline shortcodes
+
+## First Classify The Shortcode
+
+Before rewriting any shortcode, classify it into one of these groups:
+
+1. Literal documentation example
+2. Static wrapper around local content or assets
+3. Content-graph expander
+4. Data-backed renderer
+5. External example extractor
+
+This classification should drive the conversion strategy:
+
+- Literal documentation example: preserve literally
+- Static wrapper: replace with normal Markdown or HTML
+- Content-graph expander: recursively resolve local pages or sections
+- Data-backed renderer: read the referenced `data/*` or local metadata source
+- External example extractor: inspect the referenced local example files, or downgrade with an explicit note if deterministic reconstruction is not possible
+
+## Docs-Site Custom Shortcodes
+
+A typical Hugo docs site may define custom shortcodes such as these in `layouts/_shortcodes/`:
+
+- `code-toggle`
+- `datatable`
+- `deprecated-in`
+- `eturl`
+- `get-page-desc`
+- `glossary`
+- `glossary-term`
+- `hl`
+- `img`
+- `imgproc`
+- `include`
+- `module-mounts-note`
+- `new-in`
+- `newtemplatesystem`
+- `per-lang-config-keys`
+- `quick-reference`
+- `render-list-of-pages-in-section`
+- `render-table-of-pages-in-section`
+- `root-configuration-keys`
+- `syntax-highlighting-styles`
+
+Read the local template file before deciding the replacement.
+
+If the repository already contains Markdown-export partials or AI-facing templates, use them as evidence for how the site itself flattens these constructs. Do not copy them blindly without understanding which shortcodes they intentionally expand and which they intentionally leave alone.
+
+## High-Impact Local Rules
+
+### Logical content paths
+
+Some Hugo docs sites mount a language subdirectory such as `content/en` to the logical `content` root. Resolve links and `include` targets against logical paths rather than filesystem paths that retain the language prefix.
+
+### `include`
+
+`include` renders another content page through `RenderShortcodes`. This means:
+
+- the included file may contain more shortcodes
+- the included file is part of the final visible content
+- conversion must recursively resolve the referenced file
+- the included file should contribute body content, not duplicate front matter
+
+### `quick-reference`
+
+This shortcode renders sections and child pages dynamically. Replace it with a materialized Markdown structure.
+
+### `render-list-of-pages-in-section`
+
+This shortcode builds lists from a section path. Replace it with normal Markdown lists and descriptions.
+
+### `render-table-of-pages-in-section`
+
+This shortcode builds tables from a section path and filters. Replace it with a standard Markdown table if practical, otherwise a clear list.
+
+### `glossary-term` and `glossary`
+
+These inject glossary links or glossary content. Preserve the resulting prose or links, not the shortcode syntax.
+
+### `new-in` and `deprecated-in`
+
+Convert these into plain Markdown callouts or inline labels such as:
+
+- `New in Hugo 0.144.0.`
+- `Deprecated in Hugo 0.144.0.`
+
+### `code-toggle`
+
+Preserve the underlying example content as fenced code, not the UI toggle mechanism.
+
+Common parameter patterns to watch for:
+
+- `file=hugo` or similar parameters indicate repository-style config examples
+- `fm=true` means the emitted example includes front matter semantics
+- `config=` and `dataKey=` style usage can pull data-backed snippets, so read local data files before flattening the shortcode
+
+If the required data source is not locally obvious or requires remarshal logic that you cannot reproduce safely, replace the shortcode with:
+
+- the visible inline sample when one exists, or
+- a short note explaining that the repository builds multiple code variants from data at render time
+
+### `datatable`
+
+This shortcode renders a table from `hugo.Data.docs`. Materialize the table from local data when the selected package, list, and field set are clear.
+
+### `per-lang-config-keys` and `root-configuration-keys`
+
+These shortcodes summarize configuration metadata. Treat them as data-backed expanders rather than simple badges or links.
+
+### `syntax-highlighting-styles` and `chroma-lexers`
+
+These shortcodes materialize large generated lists from local data or template logic. Prefer explicit Markdown tables or lists when practical, otherwise downgrade with a clear note describing the omitted generated gallery.
+
+### `newtemplatesystem` and `hl`
+
+These are local presentation helpers. Inspect whether they emit prose, badges, or inline highlighted code before deciding the downgrade format.
+
+## Embedded Shortcodes
+
+The official Hugo docs also document embedded shortcodes. Even when the source site mostly uses custom shortcodes, treat embedded shortcodes as first-class conversion cases because other Hugo repositories often rely on them directly.
+
+High-value embedded shortcode guidance:
+
+- `details`: convert to a Markdown callout or HTML `<details>` block while preserving the summary text and body content
+- `figure`: preserve the image destination, alt text, caption, title, and attribution semantics; plain Markdown image plus surrounding caption text is usually safer than keeping shortcode syntax
+- `highlight`: convert to fenced code when the rendered result is a code sample; preserve inline highlighting as inline code or HTML only when necessary
+- `param`: resolve to the referenced site parameter if it is locally knowable, otherwise replace with a conversion note
+- `qr`: preserve the encoded text and add a note or image link only if the generated asset is locally resolvable
+- `ref` and `relref`: replace with the final resolved Markdown destination, not the shortcode itself
+- `youtube`, `vimeo`, `instagram`, and `x`: convert to stable normal links or embeds only if the destination is explicit and safe
+
+If a repository overrides an embedded shortcode in `layouts/_shortcodes`, treat the local override as authoritative.
+
+## Inline Shortcodes
+
+Inline shortcodes are rare but important because they can define executable template logic inside content.
+
+Conversion rules:
+
+- If the page is documenting inline shortcode syntax, preserve the example literally.
+- If the page is actually using an inline shortcode and the rendered text is locally obvious, preserve the rendered text rather than the template body.
+- If the rendered value depends on runtime state such as `now`, environment variables, or build context, replace it with an explicit note instead of guessing.
+
+### `glossary-term` and glossary links
+
+Some Hugo docs sites use glossary shortcuts in two forms:
+
+- `glossary-term` shortcode usage
+- Markdown links whose destination is exactly `(g)`
+
+Both should become explicit Markdown links or explicit glossary labels in the output.
+
+### `ref` and `relref`
+
+When these appear as live shortcode calls rather than literal documentation examples:
+
+- resolve them to the final destination
+- preserve query strings and fragments when they are valid
+- do not emit `ref` or `relref` literally in the final Markdown
+
+In many modern Hugo docs sites, Markdown pages generally prefer render-hook-based destination resolution instead of these shortcodes.
+
+### Content-graph expanders in other Hugo sites
+
+Other Hugo repos may use shortcodes with similar graph-expansion behavior under different names, for example:
+
+- `embed-md`
+- `table-children`
+- `command-group`
+
+Treat these as repository-specific features. Read the local shortcode or partial implementation before deciding whether it expands sibling pages, child sections, or data files.
+
+### Data-backed and example-extraction shortcodes in other Hugo sites
+
+In docs repos such as Redis or Rclone sites, expect shortcodes like:
+
+- `features-table`
+- `optional-features-table`
+- `clients-example`
+- `jupyter-example`
+
+These often depend on:
+
+- `data/*`
+- generated metadata files
+- local example source trees
+- Markdown-export partials
+
+Materialize them only when the local dependency chain is clear and deterministic. Otherwise, downgrade to a `Conversion note:` block and keep any safe inline content.
+
+## Literal Example Guardrails
+
+Preserve escaped shortcode examples even outside fenced code blocks when they are part of:
+
+- notation comparison tables
+- syntax tutorials
+- inline prose demonstrating how to call a shortcode
+
+Examples:
+
+```text
+{{%/* foo */%}}
+{{</* foo */>}}
+```
+
+Do not strip these with a generic shortcode remover.
+
+## Render Hooks
+
+The site under conversion may define render hooks for:
+
+- blockquotes
+- code blocks
+- links
+- passthrough
+- tables
+
+Important implications:
+
+- a Markdown link may resolve against pages, page resources, section resources, or global resources
+- content may depend on local validation logic for broken links
+- rendered HTML may differ from generic CommonMark defaults
+- blockquotes can carry alert semantics such as note, tip, important, warning, and caution
+- code blocks can carry file labels, copy flags, details wrappers, summaries, trim behavior, and language remapping
+- passthrough hooks can make math delimiters meaningful content rather than raw noise
+- Markdown attributes can surface in render hook context and therefore must not be stripped blindly
+
+For sites with similar render-hook patterns:
+
+- the local repository overrides render hooks for blockquotes, code blocks, links, passthrough, and tables
+- it documents heading and image render hooks, but does not override them locally in `layouts/_markup/`
+- the local link hook handles glossary shorthand `(g)`, validates fragments, and checks section resources only when the current page is not a leaf bundle
+- the local code block hook can add file labels, copy buttons, details wrappers, summaries, trim behavior, and language remapping based on code fence attributes
+
+For link-heavy pages, read the local `render-link.html` and the official render-hook docs before rewriting links.
+
+## Safe Fallback Format
+
+If a shortcode remains unresolved after inspection, replace it with a short explicit note in the final Markdown, for example:
+
+```text
+> Conversion note: `clients-example` normally renders multi-language tabs. This sample keeps only the inline Redis CLI content.
+```
+
+This is preferable to shipping live Hugo syntax or silently dropping meaning.

package/bundled-skills/hugo-to-markdown/scripts/check_standard_markdown.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+
+import argparse
+import json
+import re
+from pathlib import Path
+
+
+ACTIVE_PATTERNS = {
+    "hugo_shortcode": re.compile(r"\{\{(?:<|%)"),
+    "go_template_action": re.compile(r"\{\{\s*(?:\.|if\b|with\b|range\b|end\b|partial\b|site\b|warnf\b|errorf\b)"),
+    "local_absolute_path": re.compile(r"(?:/Users/|/home/|/private/var/folders/)"),
+    "script_tag": re.compile(r"<script\b", re.IGNORECASE),
+}
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Detect leftover Hugo syntax and unsafe residue in Markdown output.",
+    )
+    parser.add_argument("--root", required=True, help="Directory containing Markdown output")
+    parser.add_argument("--json", action="store_true", help="Emit JSON instead of text")
+    return parser.parse_args()
+
+
+def markdown_files(root: Path):
+    return sorted(
+        p for p in root.rglob("*") if p.is_file() and p.suffix.lower() in {".md", ".markdown", ".mdown"}
+    )
+
+
+def scan_file(path: Path):
+    findings = []
+    in_fence = False
+    for lineno, line in enumerate(path.read_text(encoding="utf-8", errors="replace").splitlines(), start=1):
+        stripped = line.lstrip()
+        if stripped.startswith("```") or stripped.startswith("~~~"):
+            in_fence = not in_fence
+            continue
+        if in_fence:
+            continue
+        for rule, pattern in ACTIVE_PATTERNS.items():
+            if pattern.search(line):
+                findings.append({"line": lineno, "rule": rule, "text": line.strip()})
+    return findings
+
+
+def main():
+    args = parse_args()
+    root = Path(args.root).expanduser().resolve()
+    if not root.is_dir():
+        raise SystemExit(f"Root does not exist or is not a directory: {root}")
+
+    report = []
+    for path in markdown_files(root):
+        findings = scan_file(path)
+        if findings:
+            report.append({"path": str(path), "findings": findings})
+
+    if args.json:
+        print(json.dumps(report, indent=2, ensure_ascii=False))
+    else:
+        if not report:
+            print("No active Hugo residue found outside fenced code blocks.")
+        for item in report:
+            print(item["path"])
+            for finding in item["findings"]:
+                print(f"  L{finding['line']}: {finding['rule']}: {finding['text']}")
+
+    raise SystemExit(1 if report else 0)