mirror of
https://github.com/davegallant/davegallant.github.io.git
synced 2025-08-07 00:58:13 +00:00
Switch themes to minimo
This commit is contained in:
186
themes/minimo/exampleSite/content/docs/shortcodes.md
Normal file
186
themes/minimo/exampleSite/content/docs/shortcodes.md
Normal file
@@ -0,0 +1,186 @@
|
||||
---
|
||||
date: 2017-10-05T20:00:00+06:00
|
||||
lastmod: 2020-10-06T02:00:00+06:00
|
||||
title: Shortcodes
|
||||
authors: ["muniftanjim"]
|
||||
categories:
|
||||
- features
|
||||
tags:
|
||||
- shortcode
|
||||
slug: shortcodes
|
||||
toc: true
|
||||
---
|
||||
Minimo comes with several shortcodes built-in.
|
||||
|
||||
-------
|
||||
|
||||
## Shortcode: center
|
||||
|
||||
Center align you content.
|
||||
|
||||
### center: Parameters
|
||||
|
||||
- Markdown content between opening and closing tags.
|
||||
|
||||
### center: Usage Example
|
||||
|
||||
```golang
|
||||
{{</* center */>}}
|
||||
_Center Aligned Text_
|
||||
{{</* /center */>}}
|
||||
```
|
||||
|
||||
**Output**:
|
||||
|
||||
{{< center >}}
|
||||
_Center Aligned Text_
|
||||
{{< /center >}}
|
||||
|
||||
-------
|
||||
|
||||
## Shortcode: convo
|
||||
|
||||
Renders conversation blocks.
|
||||
|
||||
### convo: Parameters
|
||||
|
||||
- `sep` [`String`] \(optional\): seperator between person and text (default: "`:`")
|
||||
|
||||
### convo: Inner Syntax
|
||||
|
||||
```golang
|
||||
person :: text
|
||||
```
|
||||
|
||||
_You can remove the **`person`** part, if you want._
|
||||
|
||||
### convo: Usage Example
|
||||
|
||||
```golang
|
||||
{{</* convo sep=":" */>}}
|
||||
|
||||
Jerry :: You don't look so tough.
|
||||
|
||||
Finch :: It's because I have only two modes, Jerry. Calm, and furious. It's a rare person that sees the latter and lives to talk about it.
|
||||
|
||||
{{</* /convo */>}}
|
||||
```
|
||||
|
||||
**Output**:
|
||||
|
||||
{{< convo sep=":" >}}
|
||||
|
||||
Jerry :: You don't look so tough.
|
||||
|
||||
Finch :: It's because I have only two modes, Jerry. Calm, and furious. It's a rare person that sees the latter and lives to talk about it.
|
||||
|
||||
{{< /convo >}}
|
||||
|
||||
-------
|
||||
|
||||
## Shortcode: file
|
||||
|
||||
Include content from seperate file with syntax highlighting.
|
||||
|
||||
### file: Parameters
|
||||
|
||||
0 => filename [`String`] \(required\)
|
||||
1 => filetype [`String`] \(optional\)
|
||||
|
||||
### file: Usage Example
|
||||
|
||||
```golang
|
||||
{{</* file "content/_index.md" */>}}
|
||||
```
|
||||
|
||||
**Output**:
|
||||
|
||||
{{< file "content/_index.md" >}}
|
||||
|
||||
-------
|
||||
|
||||
## Shortcode: katex
|
||||
|
||||
Renders KaTeX.
|
||||
|
||||
### katex: Parameters
|
||||
|
||||
0 => mode [`String`] \(optional\): inline / block
|
||||
|
||||
### katex: Usage Example
|
||||
|
||||
```golang
|
||||
Inline: {{</* katex inline */>}} ax^2 + bx + c = 0 {{</* /katex */>}}
|
||||
|
||||
Block:
|
||||
{{</* katex */>}}
|
||||
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
|
||||
{{</* /katex */>}}
|
||||
```
|
||||
|
||||
**Output**:
|
||||
|
||||
Inline: {{< katex inline >}} ax^2 + bx + c = 0 {{< /katex >}}
|
||||
|
||||
Block:
|
||||
{{< katex >}}
|
||||
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
|
||||
{{< /katex >}}
|
||||
|
||||
-------
|
||||
|
||||
## Shortcode: text
|
||||
|
||||
Text with custom size and color
|
||||
|
||||
### text: Parameters
|
||||
|
||||
You can use either Named or Unnamed Parameters
|
||||
|
||||
**Named Parameters**:
|
||||
|
||||
- `s` or `size` [`String`] \(optional\): multiplier relative to the normal size
|
||||
- `c` or `color` [`String`] \(optional\): name / hex / rgb / rgba
|
||||
|
||||
**Unnamed Parameters**:
|
||||
|
||||
0 => textsize [`String`] \(required\): multiplier relative to the normal size
|
||||
1 => textcolor [`String`] \(optional\): name / hex / rgb / rgba
|
||||
|
||||
### text: Usage Example
|
||||
|
||||
```golang
|
||||
{{</* text s="1.4" color="purple" */>}}
|
||||
font-size: 1.4em;
|
||||
color: purple;
|
||||
{{</* /text */>}}
|
||||
```
|
||||
|
||||
**Output**:
|
||||
|
||||
{{< text s="1.4" color="purple" >}}
|
||||
font-size: 1.5em;
|
||||
color: purple;
|
||||
{{< /text >}}
|
||||
|
||||
|
||||
## Shortcode: slideshare
|
||||
|
||||
As default Hugo's shortcodes for Twitter, Instagram, Vimeo, Youtube you can embed [SlideShare](https://www.slideshare.net/) presentation/document into your page.
|
||||
|
||||
### slideshare: Parameters
|
||||
|
||||
**Named Parameters**:
|
||||
|
||||
- `id` [`String`] \(required\): `id` of SlideShare you want to embed. You can find it in
|
||||
SlideShare URL or click "Share" -> See `id` field in "WordPress Shortcode" section.
|
||||
|
||||
### slideshare: Usage Example
|
||||
|
||||
```golang
|
||||
{{</* slideshare 237760779 */>}}
|
||||
```
|
||||
|
||||
**Output**:
|
||||
|
||||
{{< slideshare id="237760779" >}}
|
Reference in New Issue
Block a user