aboutsummaryrefslogtreecommitdiff
path: root/docs/4.1/content/code.md
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2018-04-09 09:00:23 -0700
committerGitHub <[email protected]>2018-04-09 09:00:23 -0700
commit8f7bd419935adfcd53c471a0202083464800619e (patch)
treed0e6ab018a0f41b59a1206cf72ffc79a474e69b9 /docs/4.1/content/code.md
parent91730a644f107ca80a747a6f7f0c173eca5708fa (diff)
downloadbootstrap-8f7bd419935adfcd53c471a0202083464800619e.tar.xz
bootstrap-8f7bd419935adfcd53c471a0202083464800619e.zip
Ship v4.1.0 (#26218)v4.1.0
* update docs path from docs/4.0/ to docs/4.1/ * bump version to 4.1.0 * Update redirects to work for 4.1 docs move * Update docs version switcher to include latest and link to 4.0 docs * re-run dist * Update package-lock.json * Update docs-navbar.html
Diffstat (limited to 'docs/4.1/content/code.md')
-rw-r--r--docs/4.1/content/code.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/4.1/content/code.md b/docs/4.1/content/code.md
new file mode 100644
index 000000000..d1ce12ccd
--- /dev/null
+++ b/docs/4.1/content/code.md
@@ -0,0 +1,55 @@
+---
+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.
+
+{% capture example %}
+For example, <code>&lt;section&gt;</code> should be wrapped as inline.
+{% endcapture %}
+{% include example.html content=example %}
+
+## 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 340px and provide a y-axis scrollbar.
+
+{% 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>
+{% endcapture %}
+{% include example.html content=example %}
+
+## Variables
+
+For indicating variables use the `<var>` tag.
+
+{% capture example %}
+<var>y</var> = <var>m</var><var>x</var> + <var>b</var>
+{% endcapture %}
+{% include example.html content=example %}
+
+## User input
+
+Use the `<kbd>` to indicate input that is typically entered via keyboard.
+
+{% capture 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>
+{% endcapture %}
+{% include example.html content=example %}
+
+## Sample output
+
+For indicating sample output from a program use the `<samp>` tag.
+
+{% capture example %}
+<samp>This text is meant to be treated as sample output from a computer program.</samp>
+{% endcapture %}
+{% include example.html content=example %}