mirror of
https://github.com/hugo-fixit/FixIt.git
synced 2026-08-24 07:18:57 +00:00
Cell
658f03d1e5
* refactor(params)!: snake_case config + eliminate params.page + use .Param
BREAKING CHANGE: All params keys renamed from camelCase to snake_case,
[params.page] section eliminated (moved to [params] level), and users
must update their hugo.toml and front matter accordingly.
Key changes:
- All camelCase config keys → snake_case (e.g., defaultTheme → default_theme)
- [params.page] flat keys and sub-sections moved to [params] level
- Removed function/params.html (manual merge), replaced with Hugo .Param
- New function/param.html partial for page-level section params with
shorthand boolean support and site defaults merging
- New function/camel-case.html for string conversion
- snake2camel.html renamed to camel-case-keys.html
- New function/get-cover.html for cover image resolution
- Deprecation warnings in detection-deprecated.html for old config keys
- Front matter only params (subtitle, featured_image, password, repost,
weight, message) use .Params.xxx instead of .Param
- Page-level sections use param.html partial
- Simplified patch.html (siteTime only) and init/index.html
Refs: camel-case-keys.html#29 (planned v1.0 breaking change)
* refactor(params)!: move params.link to page-level, simplify link guard
- Move [params.link] and [params.link.guard] to page-level section
- link.html: .Page optional, use param.html when available for
page-level override, fall back to site config without .Page
- Remove $guardConfig variable, use $config.guard directly
- Remove unnecessary .Page from callers that don't need page override
- friends.html: use param.html for link guard instead of link_guard
* refactor(params)!: move image/codeblock/json_viewer/filetree to page-level
- Move [params.image], [params.codeblock], [params.json_viewer],
[params.filetree] to page-level sub-sections
- Templates use param.html for merged config (page override + site defaults)
- image.html: .Page optional, falls back to site config without .Page
- Add v1- prefix to all deprecation warnidf IDs
- Fix camelCase key access in image.html (blackList, cacheRemote)
- Fix Hugo-lowered camelCase keys in code-block-wrapper.html
- Add deprecation warnings for codeblock camelCase Markdown attributes
- Add deprecation warnings for file-tree camelCase Markdown attributes
- Update render-codeblock-toggle.html for snake_case attribute names
* style: standardize @param comment style across all HTML templates
- PascalCase types: {string} → {String}, {boolean} → {Boolean},
{int} → {Int}, {map} → {Map}, {array} → {Array}
- Add missing ` - ` separator between param name and description
- Remove extra alignment spaces between type and param name
* refactor(params)!: move params.mermaid to page-level, extract gen/ templates
- Move [params.mermaid] to page-level sub-sections
- Mermaid config injected into window.config (per-page override support)
- mermaid.ts reads config from window.config.mermaid instead of parameter
- Create _partials/gen/ directory for JS content generators
- Move mermaid-bootstrap.html from plugin/ to gen/
- Extract window.config JS generation into gen/config.html
- mermaid.html uses param.html for wrapper config
* refactor(params)!: consolidate link_to_* into params.post_link section
- Move link_to_markdown/source/edit/report/vscode into [params.post_link]
- Rename keys: markdown, source, edit, report (bool), editor (string)
- editor defaults to "vscode", supports "trae" etc. via protocol template
- footer.html uses .Param "post_link" for all link toggles
- Remove link_to_* from deprecated keys list
* fix: add fallback for deprecated camelCase attributes and expand deprecation warnings
- render-codeblock-file-tree.html: folderSlash attribute fallback
- render-codeblock-toggle.html: lineNosToggler/lineWrapToggler fallback + warnings
- code-block-wrapper.html: maxShownLines/wrapperClass fallback
- detection-deprecated.html: add nested key warnings for 13 sections
(header, breadcrumb, navigation, watermark, busuanzi, image, mermaid,
codeblock, filetree, math.katex, math.mathjax.options, post_summary, footer)
- detection-deprecated.html: add link_guard front matter deprecation warning
* fix(mermaid): fix rendering in hidden tab panels and neutral layer scheduling
- isRenderContextActive: check tab-panel visibility via getBoundingClientRect
instead of panel.hidden (tab-container uses slot-based hiding, not hidden attr)
- bindTabContainerChanged: render neutral layers when switching tabs so
print/fallback scenarios work correctly
71 lines
2.4 KiB
HTML
71 lines
2.4 KiB
HTML
|
|
{{- /*
|
|
The extended syntax of alert is compatible with Obsidian and FixIt admonition shortcode.
|
|
@param {String} .Text - The content of the admonition box
|
|
@param {String} [.Type] - The type of the admonition box
|
|
@param {String} [.Title] - The title of the admonition box
|
|
@param {Boolean} [.Open] - Whether the admonition box is open, default is true
|
|
@param {Boolean} [.Foldable] - Whether the admonition box is foldable, default is true
|
|
For custom admonitions, see https://fixit.lruihao.cn/documentation/content-management/shortcodes/extended/admonition/#customize-admonitions
|
|
*/ -}}
|
|
|
|
{{- $iconMap := dict
|
|
"note" "fa-solid fa-pencil-alt"
|
|
"abstract" "fa-solid fa-clipboard-list"
|
|
"info" "fa-solid fa-circle-info"
|
|
"todo" "fa-solid fa-list-check"
|
|
"tip" "fa-regular fa-lightbulb"
|
|
"success" "fa-solid fa-check"
|
|
"question" "fa-regular fa-circle-question"
|
|
"warning" "fa-solid fa-exclamation-triangle"
|
|
"failure" "fa-solid fa-xmark"
|
|
"danger" "fa-solid fa-bolt"
|
|
"bug" "fa-solid fa-bug"
|
|
"example" "fa-solid fa-list-ul"
|
|
"quote" "fa-solid fa-quote-right"
|
|
-}}
|
|
{{- /* Custom admonitions */ -}}
|
|
{{- $iconMap = site.Params.admonition | merge $iconMap -}}
|
|
{{- $aliasMap := dict
|
|
"summary" "abstract"
|
|
"tldr" "abstract"
|
|
"hint" "tip"
|
|
"important" "tip"
|
|
"check" "success"
|
|
"done" "success"
|
|
"help" "question"
|
|
"faq" "question"
|
|
"caution" "warning"
|
|
"attention" "warning"
|
|
"fail" "failure"
|
|
"missing" "failure"
|
|
"error" "danger"
|
|
"cite" "quote"
|
|
-}}
|
|
{{- $type := .Type | lower -}}
|
|
{{- $type = index $aliasMap $type | default $type | default "note" -}}
|
|
{{- $icon := index $iconMap $type | default "fa-solid fa-pencil-alt" -}}
|
|
{{- $title := .Title | default (T (printf "admonition.%v" $type)) | default (title $type) -}}
|
|
{{- $titleless := eq .Title "~" -}}
|
|
{{- $foldable := ne .Foldable false -}}
|
|
|
|
<div class="details admonition {{ $type }}{{ if .Open | ne false }} open{{ end }}{{ if not $foldable }} disabled{{ end }}">
|
|
{{- if not $titleless }}
|
|
<div class="details-summary admonition-title">
|
|
{{- dict "Class" (add "icon " $icon) | partial "plugin/icon.html" -}}
|
|
{{- $title | safeHTML -}}
|
|
{{- if $foldable -}}
|
|
{{- dict "Class" "details-icon fa-solid fa-angle-right" | partial "plugin/icon.html" -}}
|
|
{{- end -}}
|
|
</div>
|
|
{{- end }}
|
|
{{- with .Text -}}
|
|
<div class="details-content">
|
|
<div class="admonition-content">
|
|
{{- . | safeHTML -}}
|
|
</div>
|
|
</div>
|
|
{{- end }}
|
|
</div>
|
|
{{- /* EOF */ -}}
|