twbootstrap/site/content/docs/4.6/content/code.md

1.4 KiB

layout title description group toc
docs Code Documentation and examples for displaying inline and multiline blocks of code with Bootstrap. content true

Inline code

Wrap inline snippets of code with <code>. Be sure to escape HTML angle brackets.

{{< example >}} For example, <section> should be wrapped as inline. {{< /example >}}

Code blocks

Use <pre>s for multiple lines of code. Once again, be sure to escape any angle brackets in the code for proper rendering. You may optionally add the .pre-scrollable class, which will set a max-height of 340px and provide a y-axis scrollbar.

{{< example >}}

<p>Sample text here...</p>
<p>And another line of sample text here...</p>

{{< /example >}}

Variables

For indicating variables use the <var> tag.

{{< example >}} y = mx + b {{< /example >}}

User input

Use the <kbd> to indicate input that is typically entered via keyboard.

{{< example >}} To switch directories, type cd followed by the name of the directory.
To edit settings, press ctrl + , {{< /example >}}

Sample output

For indicating sample output from a program use the <samp> tag.

{{< example >}} This text is meant to be treated as sample output from a computer program. {{< /example >}}