From eaeee93fa34092ee7c107d75edffd6c8274c15fb Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 9 Aug 2015 23:38:16 -0700 Subject: docs rearrange --- docs/content/code.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 docs/content/code.md (limited to 'docs/content/code.md') diff --git a/docs/content/code.md b/docs/content/code.md new file mode 100644 index 000000000..fd149d4b0 --- /dev/null +++ b/docs/content/code.md @@ -0,0 +1,53 @@ +--- +layout: page +title: Code +group: content +--- + +Styles for inline code snippets and longer, multiline blocks of code. + +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + +## 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 %} + +## 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. You may optionally add the `.pre-scrollable` class, which will set a max-height of 350px and provide a y-axis scrollbar.
+
+{% example html %}
+
<p>Sample text here...</p>
+{% endexample %} + +## Variables + +For indicating variables use the `` tag. + +{% example html %} +y = mx + b +{% 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 %} + +## 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