Code
Styles for inline code snippets and longer, multiline blocks of code.
Page Contents
Inline Code
Wrap inline snippets of code with <code>
. Be sure to escape HTML angle brackets.
For example,
<section>
should be wrapped as inline.
For example, <code><section></code> should be wrapped as inline.
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.
<p>Sample text here...</p>
<p>And another line of sample text here...</p>
<pre><code><p>Sample text here...</p>
<p>And another line of sample text here...</p>
</code></pre>
Variables
For indicating variables use the <var>
tag.
y = mx + b
<var>y</var> = <var>m</var><var>x</var> + <var>b</var>
User Input
Use the <kbd>
to indicate input that is typically entered via keyboard.
To switch directories, type cd followed by the name of the directory.
To edit settings, press ctrl + ,
To edit settings, press ctrl + ,
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>
Sample Output
For indicating sample output from a program use the <samp>
tag.
This text is meant to be treated as sample output from a computer program.
<samp>This text is meant to be treated as sample output from a computer program.</samp>
SASS Reference
Variables
The available Customization options, or Sass variables, that can be customized for the code CSS styles.
Name | Type | Default | Description |
---|---|---|---|
$enable-code |
boolean | true |
Enable the generation of the code CSS rules.
Smaller segements of the code CSS rules can be disabled with the following $enable-* variables.
|
$enable-code-code |
boolean | true |
Enable the generation of the code element CSS rules. |
$enable-code-kbd |
boolean | true |
Enable the generation of the keyboard element CSS rules. |
$enable-code-pre |
boolean | true |
Enable the generation of the pre element CSS rules. |
$code-font-size |
string | .875em |
Code and pre element font size. |
$code-padding-x |
string | .4375rem |
Code element horizontal padding. |
$code-padding-y |
string | .125rem |
Code element vertical padding. |
$code-color |
string | palette($red, 550) |
Code element text color. |
$code-bg |
string | $uibase-50 |
Code element background color. |
$kbd-font-size |
string | .875em |
Keyboard element font size. |
$kbd-color |
string | $uibase-50 |
Keyboard element text color. |
$kbd-bg |
string | $uibase-900 |
Keyboard element background color. |
$kbd-box-shadow |
string | inset 0 -.1rem 0 rgba($black, .25) |
Optional box shadow for keyboard element. |
$kbd-nested-font-weight |
string | $font-weight-bold |
Font weight for nested keyboard elements. Parent keyboard element inherit the current font weight. |
$kbd-border-radius |
string | .1875rem |
Keyboard element border radius. |
$pre-color |
string | null |
Pre element text color. |
Mixins
No mixins available.