diff options
| author | Mark Otto <[email protected]> | 2017-05-31 21:29:23 -0700 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2017-05-31 21:29:23 -0700 |
| commit | f13eb5194019b460eb01cdb251c81c76b2e7d5d0 (patch) | |
| tree | 178410fd574e52b9a0850273dacea566efa2aef0 /docs/4.0/content/code.md | |
| parent | 8a6642bbff3b86a24fc47cad42f5a23af80f057a (diff) | |
| parent | 620257456ed0685cae6b6ff51d2ab1e37f02a4fa (diff) | |
| download | bootstrap-f13eb5194019b460eb01cdb251c81c76b2e7d5d0.tar.xz bootstrap-f13eb5194019b460eb01cdb251c81c76b2e7d5d0.zip | |
Merge branch 'v4-dev' into form-tweaks
Diffstat (limited to 'docs/4.0/content/code.md')
| -rw-r--r-- | docs/4.0/content/code.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/4.0/content/code.md b/docs/4.0/content/code.md new file mode 100644 index 000000000..ddd7b9031 --- /dev/null +++ b/docs/4.0/content/code.md @@ -0,0 +1,50 @@ +--- +layout: docs +title: Code +description: Documentation and examples for displaying inline and multiline blocks of code with Bootstrap. +group: content +toc: true +--- + +## Inline code + +Wrap inline snippets of code with `<code>`. Be sure to escape HTML angle brackets. + +{% example html %} +For example, <code><section></code> should be wrapped as inline. +{% endexample %} + +## 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 350px and provide a y-axis scrollbar. + +{% example html %} +<pre><code><p>Sample text here...</p> +<p>And another line of sample text here...</p> +</code></pre> +{% endexample %} + +## Variables + +For indicating variables use the `<var>` tag. + +{% example html %} +<var>y</var> = <var>m</var><var>x</var> + <var>b</var> +{% endexample %} + +## User input + +Use the `<kbd>` to indicate input that is typically entered via keyboard. + +{% example html %} +To switch directories, type <kbd>cd</kbd> followed by the name of the directory.<br> +To edit settings, press <kbd><kbd>ctrl</kbd> + <kbd>,</kbd></kbd> +{% endexample %} + +## Sample output + +For indicating sample output from a program use the `<samp>` tag. + +{% example html %} +<samp>This text is meant to be treated as sample output from a computer program.</samp> +{% endexample %} |
