github/hugo-geekdoc
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekdoc.git synced 2024-11-21 20:30:39 +00:00
Code Issues Projects Releases Wiki Activity

docs: normalize shortcode documentation (#454)

Browse Source
This commit is contained in:
Robert Kaussow 2022-07-11 20:45:55 +02:00 committed by GitHub
parent 40ae40529a
commit c39eee4368
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
exampleSite/content/en/shortcodes/hints.md
View File

@ -4,15 +4,15 @@ title: Hints
Hint shortcode can be used as hint/alerts/notification block.
Attributes:
## Attributes
| Name | Usage | Default |
| ---------------- | --------------------------------------------------------------------------------- | --------------------- |
| type | color types to choose from | note |
| icon (optional) | custom icon to use | undefined (type name) |
| title (optional) | custom icon to use, need to be an icon from an [SVG sprite](/features/icon-sets/) | undefined (type name) |
| Name | Description | default |
| ---------------- | -------------------------------------------------------------------------------- | --------- |
| type | hint type | note |
| icon (optional) | custom icon to use,need to be an icon from an [SVG sprite](/features/icon-sets/) | undefined |
| title (optional) | hint title | undefined |
Syntax:
## Usage
<!-- prettier-ignore-start -->
```tpl

2
exampleSite/content/en/shortcodes/icons.md
View File

@ -10,7 +10,7 @@ Simple shortcode to include icons from SVG sprites outside of menus.
```
<!-- prettier-ignore-end -->
**Example:**
## Usage
| Result | Usage |
| -------------------------- | -------------------------------- |

18
exampleSite/content/en/shortcodes/images/_index.md
View File

@ -41,16 +41,16 @@ resources:
If you need more flexibility for your embedded images, you could use the `img` shortcode. It is using Hugo's
[page resources](https://gohugo.io/content-management/page-resources/) and supports lazy loading of your images.
**Attributes:**
## Attributes
| Name | Usage | Default |
| ------------- | ------------------------------------------------------------------------------------------------------------- | ----------------- |
| name (string) | Name of the image resource defined in your front matter. | empty |
| alt (string) | Description for displayed image. | resource `.Title` |
| size (string) | Thumbnail size (tiny\|small\|medium\|large). | empty |
| lazy (bool) | Enable or disable image lazy loading. Can be controlled globally by site parameter `geekdocImageLazyLoading`. | true |
| Name | Description | default |
| ---- | ------------------------------------------------------- | ----------------- |
| name | name of the image resource defined in your front matter | empty |
| alt | description for displayed image | resource `.Title` |
| size | Thumbnail size (profile\|tiny\|small\|medium\|large) | empty |
| lazy | enable or disable image lazy loading | true |
**Example:**
## Usage
Define your resources in the page front matter, custom parameter `params.credits` is optional.
@ -71,7 +71,7 @@ resources:
<!-- spellchecker-enable -->
**Demo:**
## Example
<!-- spellchecker-disable -->

2
exampleSite/content/en/shortcodes/includes.md
View File

@ -14,7 +14,7 @@ Include shortcode can include files of different types. By specifying a language
Attributes:
| Name | Usage | Default |
| Name | Description | Default |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| file | path to the included file relative to the Hugo root | undefined |
| language | language for [syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages) | undefined |

4
exampleSite/content/en/shortcodes/toc.md
View File

@ -6,11 +6,11 @@ Simple wrapper to generate a page Table of Content from a shortcode.
**Attributes:**
| Name | Usage | Default |
| Name | Description | Default |
| ------ | -------------------------- | ------------------------------------------------------------- |
| format | format of the returned ToC | <!-- spellchecker-disable -->html<!-- spellchecker-enable --> |
**Syntax:**
**Usage:**
<!-- prettier-ignore-start -->
```tpl