Commit 16552b24 authored by Mark Otto's avatar Mark Otto
Browse files

Merge pull request #18675 from patrickhlauke/docs-code1

Docs: tweaks to content code
parents ca6f6ca2 efe2419f
Showing with 7 additions and 5 deletions
+7 -5
......@@ -13,18 +13,20 @@ Styles for inline code snippets and longer, multiline blocks of code.
## Inline code
Wrap inline snippets of code with `code`. Be sure to escape HTML angle brackets.
Wrap inline snippets of code with `<code>`. Be sure to escape HTML angle brackets.
{% example html %}
For example, <code>&lt;section&gt;</code> should be wrapped as inline.
{% endexample %}
## Preformatted text
## Code blocks
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. You may optionally add the `.pre-scrollable` class, which will set a max-height of 350px and provide a y-axis scrollbar.
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.
{% example html %}
<pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
<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>
{% endexample %}
## Variables
......@@ -46,7 +48,7 @@ To edit settings, press <kbd><kbd>ctrl</kbd> + <kbd>,</kbd></kbd>
## Sample output
For indicating blocks sample output from a program use the `<samp>` tag.
For indicating 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>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment