code.html 2.24 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
3
4
5
<div class="bs-docs-section">
  <h1 id="code" class="page-header">Code</h1>

  <h2 id="code-inline">Inline</h2>
  <p>Wrap inline snippets of code with <code>&lt;code&gt;</code>.</p>
6
<div class="bs-example" data-example-id="inline-code">
Mark Otto's avatar
Mark Otto committed
7
8
9
10
11
12
13
14
  For example, <code>&lt;section&gt;</code> should be wrapped as inline.
</div>
{% highlight html %}
For example, <code>&lt;section&gt;</code> should be wrapped as inline.
{% endhighlight %}

  <h2 id="code-user-input">User input</h2>
  <p>Use the <code>&lt;kbd&gt;</code> to indicate input that is typically entered via keyboard.</p>
15
<div class="bs-example" data-example-id="simple-kbd">
16
17
  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>
Mark Otto's avatar
Mark Otto committed
18
19
</div>
{% highlight html %}
20
21
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>
Mark Otto's avatar
Mark Otto committed
22
23
24
25
{% endhighlight %}

  <h2 id="code-block">Basic block</h2>
  <p>Use <code>&lt;pre&gt;</code> for multiple lines of code. Be sure to escape any angle brackets in the code for proper rendering.</p>
26
<div class="bs-example" data-example-id="simple-pre">
Mark Otto's avatar
Mark Otto committed
27
28
29
30
31
32
33
34
35
  <pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
</div>
{% highlight html %}
<pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
{% endhighlight %}

  <p>You may optionally add the <code>.pre-scrollable</code> class, which will set a max-height of 350px and provide a y-axis scrollbar.</p>
  <h2 id="code-variables">Variables</h2>
  <p>For indicating variables use the <code>&lt;var&gt;</code> tag.</p>
36
  <div class="bs-example" data-example-id="simple-var">
Mark Otto's avatar
Mark Otto committed
37
38
39
40
41
42
43
44
45
    <p><var>y</var> = <var>m</var><var>x</var> + <var>b</var></p>

  </div>
{% highlight html %}
<var>y</var> = <var>m</var><var>x</var> + <var>b</var>
{% endhighlight %}

  <h2 id="code-sample-output">Sample output</h2>
  <p>For indicating blocks sample output from a program use the <code>&lt;samp&gt;</code> tag.</p>
46
  <div class="bs-example" data-example-id="simple-samp">
Mark Otto's avatar
Mark Otto committed
47
48
49
50
51
52
    <p><samp>This text is meant to be treated as sample output from a computer program.</samp></p>
  </div>
{% highlight html %}
<samp>This text is meant to be treated as sample output from a computer program.</samp>
{% endhighlight %}
</div>