rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2025-01-17 09:52:29 +01:00
Code Issues Actions Packages Releases Activity

reorganize code docs

Browse Source
This commit is contained in:
Mark Otto 2015-04-17 20:19:51 -07:00
parent 2fb6dc26c8
commit fe203ec382
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/components/code.md
View File

@ -13,25 +13,14 @@ Wrap inline snippets of code with `code`. Be sure to escape HTML angle brackets.
For example, <code>&lt;section&gt;</code> should be wrapped as inline.
{% 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 %}
## 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.
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. 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>&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.
## Variables
For indicating variables use the `<var>` tag.
@ -40,6 +29,15 @@ For indicating variables use the `<var>` tag.
<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 blocks sample output from a program use the `<samp>` tag.