Skip to content

Commit dacb005

Browse files
authored
Merge pull request #42337 from sftim/20230801_fix_codenew_advice
Fix explanation of custom code shortcode
2 parents e168005 + 27d65c1 commit dacb005

File tree

1 file changed

+4
-3
lines changed
  • content/en/docs/contribute/style/hugo-shortcodes

1 file changed

+4
-3
lines changed

content/en/docs/contribute/style/hugo-shortcodes/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,9 +271,7 @@ Renders to:
271271
{{< tab name="JSON File" include="podtemplate.json" />}}
272272
{{< /tabs >}}
273273

274-
### Source code files
275-
276-
`{{%/* codenew */%}}` shortcode is replaced by `{{%/* code */%}}`.
274+
## Source code files
277275

278276
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.
279277

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

301+
The legacy `{{%/* codenew */%}}` shortcode is being replaced by `{{%/* code */%}}`.
302+
Use `{{%/* code */%}}` in new documentation.
303+
303304
## Third party content marker
304305

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

0 commit comments

Comments
 (0)