diff options
| author | Mark Otto <[email protected]> | 2017-05-28 22:50:57 -0700 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2017-05-29 23:32:28 -0700 |
| commit | 3e76d6565603fafa2c85ad81d7b6345c4e279c72 (patch) | |
| tree | fad0aa6a4a70cafb4a803bd920d6ae2fa44dc466 /docs/4.0/content/code.md | |
| parent | 32153eb7cba316b873e82cd7b9362c92ca00eddf (diff) | |
| download | bootstrap-3e76d6565603fafa2c85ad81d7b6345c4e279c72.tar.xz bootstrap-3e76d6565603fafa2c85ad81d7b6345c4e279c72.zip | |
Rearrange all the docs to allow for a docs/major.minor/ setup
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 %} |
