1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-2088: Added quick start code snippet syntax reference

This commit is contained in:
Ashley Hardin
2021-06-04 16:10:02 -04:00
committed by openshift-cherrypick-robot
parent 22e953f788
commit 6457f56efe
2 changed files with 36 additions and 0 deletions

View File

@@ -0,0 +1,34 @@
// Module included in the following assemblies:
//
// * web_console/creating-quick-start-tutorials.adoc
[id="quick-starts-accessing-and-executing-code-snippets_{context}"]
= Code snippet markdown reference
You can execute a CLI code snippet when it is included in a quick start from the web console. To use this feature, you must first install the Web Terminal Operator. The web terminal and code snippet actions that execute in the web terminal are not present if you do not install the Web Terminal Operator. Alternatively, you can copy a code snippet to the clipboard regardless of whether you have the Web Terminal Operator installed or not.
[id="quick-starts-syntax-for-inline-code-snippets_{context}"]
== Syntax for inline code snippets
----
`code block`{{copy}}
`code block`{{execute}}
----
[NOTE]
====
If the `execute` syntax is used, the *Copy to clipboard* action is present whether you have the Web Terminal Operator installed or not.
====
[id="quick-starts-syntax-for-multi-line-code-snippets_{context}"]
== Syntax for multi-line code snippets
----
```
multi line code block
```{{copy}}
```
multi line code block
```{{execute}}
----

View File

@@ -27,6 +27,8 @@ include::modules/quick-starts-supported-tags.adoc[leveloffset=+2]
include::modules/quick-starts-highlighting-reference.adoc[leveloffset=+2]
include::modules/quick-starts-accessing-and-executing-code-snippets.adoc[leveloffset=+2]
include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
[id="quick-start-tutorials-additional-resources"]