diff options
Diffstat (limited to 'docs/components/code.md')
| -rw-r--r-- | docs/components/code.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/components/code.md b/docs/components/code.md new file mode 100644 index 000000000..965b4bbc0 --- /dev/null +++ b/docs/components/code.md @@ -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><section></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><p>Sample text here...</p></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 %} |
