Add admonition type to shortcode (#9482)

* Change existing admon blocks

* Fix includes issue
This commit is contained in:
Luc Perkins
2018-11-06 11:33:04 -08:00
committed by k8s-ci-robot
parent e839031292
commit d65e1790ff
192 changed files with 673 additions and 543 deletions
@@ -32,7 +32,7 @@ weight: 10
{{% note %}}
**Note:** For page weights, it can be smart not to use 1, 2, 3 ..., but some other interval, say 10, 20, 30... This allows you to insert pages where you want later.
For page weights, it can be smart not to use 1, 2, 3 ..., but some other interval, say 10, 20, 30... This allows you to insert pages where you want later.
{{% /note %}}
@@ -56,7 +56,7 @@ linkTitle: Title used in links
{{% note %}}
**Note:** The above needs to be done per language. If you don't see your section in the menu, it is probably because it is not identified as a section by Hugo. Create a `_index.md` content file in the section folder.
The above needs to be done per language. If you don't see your section in the menu, it is probably because it is not identified as a section by Hugo. Create a `_index.md` content file in the section folder.
{{% /note %}}
### Documentation Side Menu
@@ -5,5 +5,5 @@ title: Example #1
This is an **example** content file inside the **includes** leaf bundle.
{{< note >}}
**Note:** Included content files can also contain shortcodes.
Included content files can also contain shortcodes.
{{< /note >}}
@@ -154,7 +154,9 @@ println "This is tab 2."
{{</* tabs name="tab_with_md" >}}
{{% tab name="Markdown" %}}
This is **some markdown.**
{{< note >}}**Note:** It can even contain shortcodes.{{< /note >}}
{{< note >}}
It can even contain shortcodes.
{{< /note >}}
{{% /tab %}}
{{< tab name="HTML" >}}
<div>
@@ -170,7 +172,11 @@ Will be rendered as:
{{< tabs name="tab_with_md" >}}
{{% tab name="Markdown" %}}
This is **some markdown.**
{{< note >}}**Note:** It can even contain shortcodes.{{< /note >}}
{{< note >}}
It can even contain shortcodes.
{{< /note >}}
{{% /tab %}}
{{< tab name="HTML" >}}
<div>
@@ -15,7 +15,7 @@ directory of the [`kubernetes/website`](https://github.com/kubernetes/website)
repository.
{{< note >}}
**Note**: Every new topic needs to use a template. If you are unsure which
Every new topic needs to use a template. If you are unsure which
template to use for a new topic, start with the
[concept template](#concept-template).
{{< /note >}}
+14 -12
View File
@@ -19,7 +19,7 @@ docs, follow the instructions on
{{% capture body %}}
{{< note >}}
**Note:** Kubernetes documentation uses [Blackfriday Markdown Renderer](https://github.com/russross/blackfriday) along with a few [Hugo Shortcodes](/docs/home/contribute/includes/) to support glossary entries, tabs,
Kubernetes documentation uses [Blackfriday Markdown Renderer](https://github.com/russross/blackfriday) along with a few [Hugo Shortcodes](/docs/home/contribute/includes/) to support glossary entries, tabs,
and representing feature state.
{{< /note >}}
@@ -189,7 +189,8 @@ A list of Kubernetes-specific terms and words to be used consistently across the
</table>
## Shortcodes
Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create different rhetorical appeal levels. Our documentation supports three different shortcodes in this category: **Note:** {{</* note */>}}, **Caution:** {{</* caution */>}}, and **Warning:** {{</* warning */>}}.
Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create different rhetorical appeal levels. Our documentation supports three different shortcodes in this category: **Note** {{</* note */>}}, **Caution** {{</* caution */>}}, and **Warning** {{</* warning */>}}.
1. Surround the text with an opening and closing shortcode.
@@ -197,7 +198,7 @@ Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create d
```
{{</* note */>}}
**Note:** The prefix you use is the same text you use in the tag.
No need to include a prefix; the shortcode automatically provides on (Note:, Caution:, etc.).
{{</* /note */>}}
```
@@ -205,7 +206,7 @@ Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create d
The output is:
{{< note >}}
**Note:** The prefix you choose is the same text for the tag.
The prefix you choose is the same text for the tag.
{{< /note >}}
### Note
@@ -216,14 +217,14 @@ For example:
```
{{</* note */>}}
**Note:** You can _still_ use Markdown inside these callouts.
You can _still_ use Markdown inside these callouts.
{{</* /note */>}}
```
The output is:
{{< note >}}
**Note:** You can _still_ use Markdown inside these callouts.
You can _still_ use Markdown inside these callouts.
{{< /note >}}
### Caution
@@ -234,14 +235,14 @@ For example:
```
{{</* caution */>}}
**Caution:** The callout style only applies to the line directly above the tag.
The callout style only applies to the line directly above the tag.
{{</* /caution */>}}
```
The output is:
{{< caution >}}
**Caution:** The callout style only applies to the line directly above the tag.
The callout style only applies to the line directly above the tag.
{{< /caution >}}
### Warning
@@ -252,7 +253,7 @@ For example:
```
{{</* warning */>}}
**Warning:** Beware.
Beware.
{{</* /warning */>}}
```
@@ -260,7 +261,7 @@ For example:
The output is:
{{< warning >}}
**Warning:** Beware.
Beware.
{{< /warning >}}
### Katacoda Embedded Live Environment
@@ -273,7 +274,7 @@ The Embedded Live Environment is configured to run `minikube start` and lets use
as the documentation.
{{< caution >}}
**Caution:** The session is limited to 15 minutes.
The session is limited to 15 minutes.
{{< /caution >}}
For example:
@@ -306,7 +307,8 @@ The output is:
1. Preheat oven to 350˚F
1. Prepare the batter, and pour into springform pan.
{{< note >}}**Note:** Grease the pan for best results.{{< /note >}}
{{< note >}}Grease the pan for best results.{{< /note >}}
1. Bake for 20-25 minutes or until set.
@@ -137,7 +137,7 @@ file located at `/content/en/examples/pods/storage/gce-volume.yaml`.
```
{{< note >}}
**Note**: To show raw Hugo shortcodes as in the above example and prevent Hugo
To show raw Hugo shortcodes as in the above example and prevent Hugo
from interpreting them, use C-style comments directly after the `<` and before
the `>` characters. View the code for this page for an example.
{{< /note >}}
@@ -155,7 +155,7 @@ kubectl create -f https://k8s.io/examples/pods/storage/gce-volume.yaml
```
{{< note >}}
**Note**: When adding new YAML files to the `<LANG>/examples` directory, make
When adding new YAML files to the `<LANG>/examples` directory, make
sure the file is also included into the `<LANG>/examples_test.go` file. The
Travis CI for the Website automatically runs this test case when PRs are
submitted to ensure all examples pass the tests.