2014-07-12 07:34:47 +02:00
---
2015-08-15 07:45:55 +02:00
layout: docs
2014-07-12 07:34:47 +02:00
title: Code
2015-08-10 08:38:16 +02:00
group: content
2014-07-12 07:34:47 +02:00
---
2014-07-10 09:01:03 +02:00
Styles for inline code snippets and longer, multiline blocks of code.
2015-05-29 10:58:52 +02:00
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
2014-07-10 09:01:03 +02:00
## Inline code
2015-12-25 14:44:33 +01:00
Wrap inline snippets of code with `<code>` . Be sure to escape HTML angle brackets.
2014-07-10 09:01:03 +02:00
{% example html %}
For example, < code > < section> < / code > should be wrapped as inline.
{% endexample %}
2015-12-25 22:26:41 +01:00
## Code blocks
2014-07-10 09:01:03 +02:00
2015-12-25 22:26:41 +01:00
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.
2014-07-10 09:01:03 +02:00
{% example html %}
2015-12-25 14:49:16 +01:00
< pre > < code > < p> Sample text here...< /p>
< p> And another line of sample text here...< /p>
< / code > < / pre >
2014-07-10 09:01:03 +02:00
{% endexample %}
## Variables
For indicating variables use the `<var>` tag.
{% example html %}
< var > y< / var > = < var > m< / var > < var > x< / var > + < var > b< / var >
{% endexample %}
2015-04-18 05:19:51 +02:00
## 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 %}
2014-07-10 09:01:03 +02:00
## Sample output
2015-12-25 22:26:41 +01:00
For indicating sample output from a program use the `<samp>` tag.
2014-07-10 09:01:03 +02:00
{% example html %}
< samp > This text is meant to be treated as sample output from a computer program.< / samp >
{% endexample %}