Sha256: bf4a4ba037771118f625168bbf6df3158011587a4827580de7cea65d1a235df8

Contents?: true

Size: 1.22 KB

Versions: 1

Compression:

Stored size: 1.22 KB

Contents

### Conventions used

We use inline `code snippets` for short commands or pieces of code, and also for file and folder names on a system.

Larger pieces of code will be shown in their own block, where possible with syntax highlighting.

```
This is a block of code without an associated language.
In general, code blocks have the same left-hand border colour.
```

There is one main variation for code blocks.

```bash
$ This is a block of command line code, using bash syntax highlighting.
$ The command line blocks use a different left-hand border colour.
$ Usually, a command line begins with '$ '.
```

There are a few ways to highlight a paragraph.

{:.warning}

A warning block offers information about potential pitfalls or errors.

To create a warning block, include a line above it like this:

```md
{.warning}

This paragraph will become a warning.
```

{:.info}

An info block provides important hints or pointers.

Creating an info block works the same as creating a warning block.

**Note 1**: To start a page with a warning or info block, use shift-enter between the tag and the text.

**Note 2**: It is not possible to create a block with more than  1 paragraph. (When using an HTML <div> block, Markdown in the block would not be parsed.)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
dataworkbench-jekyll-theme-0.3.1 _includes/conventions.md