0
0
mirror of https://github.com/twbs/bootstrap.git synced 2025-01-10 03:46:13 +01:00

56 lines
1.6 KiB
Markdown
Raw Normal View History

2014-07-11 22:34:47 -07:00
---
layout: docs
2014-07-11 22:34:47 -07:00
title: Code
description: Documentation and examples for displaying inline and multiline blocks of code with Bootstrap.
2015-08-09 23:38:16 -07:00
group: content
2017-05-27 22:16:44 -07:00
toc: true
2014-07-11 22:34:47 -07:00
---
2014-07-10 00:01:03 -07:00
## Inline code
2015-12-25 13:44:33 +00:00
Wrap inline snippets of code with `<code>`. Be sure to escape HTML angle brackets.
2014-07-10 00:01:03 -07:00
2018-03-14 16:44:38 +01:00
{% capture example %}
2014-07-10 00:01:03 -07:00
For example, <code>&lt;section&gt;</code> should be wrapped as inline.
2018-03-14 16:44:38 +01:00
{% endcapture %}
{% include example.html content=example %}
2014-07-10 00:01:03 -07:00
## Code blocks
2014-07-10 00:01:03 -07:00
2018-02-02 22:38:01 -08:00
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.
2014-07-10 00:01:03 -07:00
2018-03-14 16:44:38 +01:00
{% capture example %}
<pre><code>&lt;p&gt;Sample text here...&lt;/p&gt;
&lt;p&gt;And another line of sample text here...&lt;/p&gt;
</code></pre>
2018-03-14 16:44:38 +01:00
{% endcapture %}
{% include example.html content=example %}
2014-07-10 00:01:03 -07:00
## Variables
For indicating variables use the `<var>` tag.
2018-03-14 16:44:38 +01:00
{% capture example %}
2014-07-10 00:01:03 -07:00
<var>y</var> = <var>m</var><var>x</var> + <var>b</var>
2018-03-14 16:44:38 +01:00
{% endcapture %}
{% include example.html content=example %}
2014-07-10 00:01:03 -07:00
2015-04-17 20:19:51 -07:00
## User input
Use the `<kbd>` to indicate input that is typically entered via keyboard.
2018-03-14 16:44:38 +01:00
{% capture example %}
2015-04-17 20:19:51 -07:00
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>
2018-03-14 16:44:38 +01:00
{% endcapture %}
{% include example.html content=example %}
2015-04-17 20:19:51 -07:00
2014-07-10 00:01:03 -07:00
## Sample output
For indicating sample output from a program use the `<samp>` tag.
2014-07-10 00:01:03 -07:00
2018-03-14 16:44:38 +01:00
{% capture example %}
2014-07-10 00:01:03 -07:00
<samp>This text is meant to be treated as sample output from a computer program.</samp>
2018-03-14 16:44:38 +01:00
{% endcapture %}
{% include example.html content=example %}