8f7bd41993
* 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
1.6 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Code | Documentation and examples for displaying inline and multiline blocks of code with Bootstrap. | content | true |
Inline code
Wrap inline snippets of code with <code>. Be sure to escape HTML angle brackets.
{% capture example %}
For example, <section> 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 %}
<p>Sample text here...</p>
<p>And another line of sample text here...</p>
{% endcapture %} {% include example.html content=example %}
Variables
For indicating variables use the <var> tag.
{% capture example %} y = mx + b {% 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 cd followed by the name of the directory.
To edit settings, press ctrl + ,
{% endcapture %}
{% include example.html content=example %}
Sample output
For indicating sample output from a program use the <samp> tag.
{% capture example %} This text is meant to be treated as sample output from a computer program. {% endcapture %} {% include example.html content=example %}