From 0156f9a2379b68cd3cf284bc4e7799fda221203e Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 17 Apr 2015 12:41:49 -0700 Subject: move remaining files to components subdir --- docs/components/code.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/components/code.md (limited to 'docs/components/code.md') diff --git a/docs/components/code.md b/docs/components/code.md new file mode 100644 index 000000000..19c02c84e --- /dev/null +++ b/docs/components/code.md @@ -0,0 +1,49 @@ +--- +layout: page +title: Code +--- + +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. + +{% example html %} +For example, <section> should be wrapped as inline. +{% endexample %} + +## User input + +Use the `` to indicate input that is typically entered via keyboard. + +{% example html %} +To switch directories, type cd followed by the name of the directory.
+To edit settings, press ctrl + , +{% endexample %} + +## Preformatted text + +Or, code blocks. Use `
`s for multiple lines of code. Once again, be sure to escape any angle brackets in the code for proper rendering.
+
+{% example html %}
+
<p>Sample text here...</p>
+{% endexample %} + +You may optionally add the `.pre-scrollable` class, which will set a max-height of 350px and provide a y-axis scrollbar. + +## Variables + +For indicating variables use the `` tag. + +{% example html %} +y = mx + b +{% endexample %} + +## Sample output + +For indicating blocks sample output from a program use the `` tag. + +{% example html %} +This text is meant to be treated as sample output from a computer program. +{% endexample %} -- cgit v1.2.3