kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added info for <codenew> shortcode in style guide (#39764) 

* Add info for codenew shortcode in style guide

Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>

* Update content/en/docs/contribute/style/style-guide.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* Addressed feedback comments

Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>

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

Co-authored-by: Brad Topol <btopol@us.ibm.com>

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

Co-authored-by: Brad Topol <btopol@us.ibm.com>

---------

Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Brad Topol <btopol@us.ibm.com>
pull/39857/head
Dipesh Rawat 2023-03-08 13:37:12 +00:00 committed by GitHub
parent 5087c55e2a
commit e7e4de3a0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -271,6 +271,33 @@ Renders to:
{{< tab name="JSON File" include="podtemplate.json" />}}
{{< /tabs >}}
### Source code files
You can use the `{{</* codenew */>}}` 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.
This shortcode takes in two named parameters: `language` and `file`. The mandatory parameter `file` is used to specify the path to the file being displayed. The optional parameter `language` is used to specify the programming language of the file. If the `language` parameter is not provided, the shortcode will attempt to guess the language based on the file extension.
For example:
```none
{{</* codenew language="yaml" file="application/deployment-scale.yaml" */>}}
```
The output is:
{{< codenew language="yaml" file="application/deployment-scale.yaml" >}}
When adding a new sample file, such as a YAML file, create the file in one of the `<LANG>/examples/` subdirectories where `<LANG>` is the language for the page. In the markdown of your page, use the `codenew` shortcode:
```none
{{</* codenew file="<RELATIVE-PATH>/example-yaml>" */>}}
```
where `<RELATIVE-PATH>` is the path to the sample file to include, relative to the `examples` directory. The following shortcode references a YAML file located at `/content/en/examples/configmap/configmaps.yaml`.
```none
{{</* codenew file="configmap/configmaps.yaml" */>}}
```
## Third party content marker
Running Kubernetes requires third-party software. For example: you

1
content/en/docs/contribute/style/style-guide.md
View File

@ -631,4 +631,5 @@ These steps ... | These simple steps ...
* Learn about [writing a new topic](/docs/contribute/style/write-new-topic/).
* Learn about [using page templates](/docs/contribute/style/page-content-types/).
* Learn about [custom hugo shortcodes](/docs/contribute/style/hugo-shortcodes/).
* Learn about [creating a pull request](/docs/contribute/new-content/open-a-pr/).