Remove experimental shortcodes: badges, cards
This commit is contained in:
@@ -31,7 +31,6 @@ It is an attempt to create a sustainable web project.
|
|||||||
- ### Shortcodes {anchor=false}
|
- ### Shortcodes {anchor=false}
|
||||||
Pretty good shortcodes are included to enhance content:
|
Pretty good shortcodes are included to enhance content:
|
||||||
[Columns](/docs/content/shortcodes/columns/),
|
[Columns](/docs/content/shortcodes/columns/),
|
||||||
[Cards](/docs/content/shortcodes/experimental/cards/),
|
|
||||||
[Tabs](/docs/content/shortcodes/tabs/),
|
[Tabs](/docs/content/shortcodes/tabs/),
|
||||||
[Images](/docs/content/shortcodes/experimental/images/),
|
[Images](/docs/content/shortcodes/experimental/images/),
|
||||||
[Asciinema](/docs/content/shortcodes/asciinema/),
|
[Asciinema](/docs/content/shortcodes/asciinema/),
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
# Badges
|
|
||||||
|
|
||||||
Inline labels for annotating content with status, versions, or metadata.
|
|
||||||
|
|
||||||
## Syntax
|
|
||||||
|
|
||||||
```tpl
|
|
||||||
{{</* badge style="info" title="Hugo" value="0.158" */>}}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Styles
|
|
||||||
|
|
||||||
| Shortcode | Output |
|
|
||||||
| -- | -- |
|
|
||||||
| `{{</* badge style="info" title="Hugo" value="0.158" */>}}` | {{< badge style="info" title="Hugo" value="0.158" >}} |
|
|
||||||
| `{{</* badge style="success" title="Build" value="Passing" */>}}` | {{< badge style="success" title="Build" value="Passing" >}} |
|
|
||||||
| `{{</* badge style="warning" title="Coverage" value="25%" */>}}` | {{< badge style="warning" title="Coverage" value="25%" >}} |
|
|
||||||
| `{{</* badge style="danger" title="Issues" value="120" */>}}` | {{< badge style="danger" title="Issues" value="120" >}} |
|
|
||||||
| | |
|
|
||||||
| `{{</* badge style="info" title="Title" */>}}` | {{< badge style="info" title="Title" >}} |
|
|
||||||
| `{{</* badge style="info" value="Value" */>}}` | {{< badge style="info" value="Value" >}} |
|
|
||||||
| `{{</* badge value="Default" */>}}` | {{< badge value="Default" >}} |
|
|
||||||
|
|
||||||
## Use in Links
|
|
||||||
|
|
||||||
Wrap a badge in a markdown link
|
|
||||||
|
|
||||||
```tpl
|
|
||||||
[{{</* badge title="Hugo" value="0.158" */>}}](https://github.com/gohugoio/hugo/releases/tag/v0.158.0)
|
|
||||||
```
|
|
||||||
|
|
||||||
[{{< badge title="Hugo" value="0.158" >}}](https://github.com/gohugoio/hugo/releases/tag/v0.158.0)
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
`style`
|
|
||||||
: Visual style. One of: `default`, `info`, `success`, `warning`, `danger`, `note`, `tip`, `important`, `caution`.
|
|
||||||
|
|
||||||
`title`
|
|
||||||
: Label text (left side).
|
|
||||||
|
|
||||||
`value`
|
|
||||||
: Value text (right side).
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
# Cards
|
|
||||||
|
|
||||||
Content blocks with optional images and links. Often used with [Columns](/docs/content/shortcodes/columns/) for grid layouts.
|
|
||||||
|
|
||||||
## Syntax
|
|
||||||
|
|
||||||
```tpl
|
|
||||||
{{</* card [href="..."] [image="..."] [title="..."] */>}}
|
|
||||||
Markdown content
|
|
||||||
{{</* /card */>}}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
{{% columns %}}
|
|
||||||
- {{< card image="placeholder.svg" >}}
|
|
||||||
### With Image
|
|
||||||
Cards can display an image above the content.
|
|
||||||
{{< /card >}}
|
|
||||||
|
|
||||||
- {{< card href="/docs/content/shortcodes/experimental/cards/" >}}
|
|
||||||
### With Link {anchor=false}
|
|
||||||
When `href` is set, the entire card becomes clickable.
|
|
||||||
{{< /card >}}
|
|
||||||
|
|
||||||
- {{< card title="Card" >}}
|
|
||||||
### Plain Card
|
|
||||||
A basic card with no image or link, used for grouping related content.
|
|
||||||
{{< /card >}}
|
|
||||||
{{% /columns %}}
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
`href`
|
|
||||||
: Makes the card a link. The entire card area becomes clickable.
|
|
||||||
|
|
||||||
`image`
|
|
||||||
: Path to an image displayed above the card content. Supports page resources and URLs.
|
|
||||||
|
|
||||||
`title`
|
|
||||||
: Accessible title for the card.
|
|
||||||
|
|
||||||
`alt`
|
|
||||||
: Alt text for the card image.
|
|
||||||
|
|
||||||
`class`
|
|
||||||
: Additional CSS classes.
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
{{- $style := or (.Get "style") (.Get 0) "default" -}}
|
|
||||||
{{- $attributes := partial "docs/text/mapper" (dict
|
|
||||||
"attributes" (cond .IsNamedParams .Params dict)
|
|
||||||
"merge" (dict
|
|
||||||
"class" (slice "book-badge" $style)
|
|
||||||
)
|
|
||||||
) -}}
|
|
||||||
<span {{ partial "docs/html-attrs" $attributes | safeHTMLAttr }}>
|
|
||||||
{{- with or (.Get "title") (.Get 1) -}}<span class="book-badge-title">{{ . | plainify }}</span>{{- end -}}
|
|
||||||
{{- with or (.Get "value") (.Get 2) -}}<span class="book-badge-value">{{ . | plainify }}</span>{{- end -}}
|
|
||||||
</span>
|
|
||||||
{{- /* remove whitespaces */ -}}
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
{{- with .Get "href" -}}
|
|
||||||
{{- $destination := partial "docs/links/portable-link" (dict "Page" $.Page "Destination" .) -}}
|
|
||||||
<div class="book-card{{ with $.Get "class" }} {{ . }}{{ end }}"><a href="{{ $destination | safeURL }}">
|
|
||||||
{{- template "book-card-content" $ -}}
|
|
||||||
</a></div>
|
|
||||||
{{- else -}}
|
|
||||||
<div class="book-card{{ with .Get "class" }} {{ . }}{{ end }}">
|
|
||||||
{{- template "book-card-content" $ -}}
|
|
||||||
</div>
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "book-card-content" -}}
|
|
||||||
{{- with .Get "image" -}}
|
|
||||||
{{- $destination := partial "docs/links/portable-image" (dict "Page" $.Page "Destination" .) -}}
|
|
||||||
<img src="{{ $destination | safeURL }}" alt="{{ partial "docs/text/i18n" ($.Get "alt" ) }}" />
|
|
||||||
{{- end -}}
|
|
||||||
<div class="markdown-inner">
|
|
||||||
{{ with .Inner }}{{ . }}{{ end -}}
|
|
||||||
</div>
|
|
||||||
{{- end -}}
|
|
||||||
Reference in New Issue
Block a user