Skip to content

Commit

Permalink
Fix explanation of custom code shortcode
Browse files Browse the repository at this point in the history
  • Loading branch information
sftim committed Aug 1, 2023
1 parent 2c969da commit 27d65c1
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions content/en/docs/contribute/style/hugo-shortcodes/index.md
Expand Up @@ -271,9 +271,7 @@ Renders to:
{{< tab name="JSON File" include="podtemplate.json" />}}
{{< /tabs >}}

### Source code files

`{{%/* codenew */%}}` shortcode is replaced by `{{%/* code */%}}`.
## Source code files

You can use the `{{%/* code */%}}` shortcode to embed the contents of file in a code block to allow users to download or copy its content to their clipboard. This shortcode is used when the contents of the sample file is generic and reusable, and you want the users to try it out themselves.

Expand All @@ -300,6 +298,9 @@ where `<RELATIVE-PATH>` is the path to the sample file to include, relative to t
{{%/* code file="configmap/configmaps.yaml" */%}}
```

The legacy `{{%/* codenew */%}}` shortcode is being replaced by `{{%/* code */%}}`.
Use `{{%/* code */%}}` in new documentation.

## Third party content marker

Running Kubernetes requires third-party software. For example: you
Expand Down

0 comments on commit 27d65c1

Please sign in to comment.