0
0
mirror of https://github.com/twbs/bootstrap.git synced 2025-02-19 16:54:24 +01:00

code page ported to markdown

This commit is contained in:
Mark Otto 2014-07-10 00:01:03 -07:00
parent bae1604110
commit 313ea2706e
3 changed files with 69 additions and 53 deletions

View File

@ -1,52 +0,0 @@
<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>
<div class="bs-example">
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>
<div class="bs-example">
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>
</div>
{% highlight 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>
{% 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>
<div class="bs-example">
<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>
<div class="bs-example">
<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>
<div class="bs-example">
<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>

View File

@ -0,0 +1,68 @@
<a id="code"></a>
# Code
Styles for inline code snippets and longer, multiline blocks of code.
<a id="code-inline"></a>
## Inline code
Wrap inline snippets of code with `code`. Be sure to escape HTML angle brackets.
{% example html %}
For example, <code>&lt;section&gt;</code> should be wrapped as inline.
{% endexample %}
<a id="code-user-input"></a>
## 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 %}
<a id="code-block"></a>
## Preformatted text
Or, 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.
{% example html %}
<pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
{% endexample %}
You may optionally add the `.pre-scrollable` class, which will set a max-height of 350px and provide a y-axis scrollbar.
<a id="code-variables"></a>
## Variables
For indicating variables use the `<var>` tag.
{% example html %}
<var>y</var> = <var>m</var><var>x</var> + <var>b</var>
{% endexample %}
<a id="code-sample-output"></a>
## Sample output
For indicating blocks 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 %}

View File

@ -9,9 +9,9 @@ lead: "Global CSS settings, fundamental HTML elements styled and enhanced with e
{% include css/overview.md %}
{% include css/grid.md %}
{% include css/type.md %}
{% include css/code.md %}
{% endmarkdown %}
{% include css/code.html %}
{% include css/tables.html %}
{% include css/forms.html %}