Contents

### Include Text As Pre

Use file inclusion to include text as pre-formatted (rather than as a code block).

You might need to do this if you have text to include that has triple-backticks.

#### File to Be Included

Here's a file containing text to be included; the text has triple-backticks.:

```triple_backtick.md```:
```markdown
This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
```

#### Includer File

Here's a template file that includes it:

```includer.md```:
```markdown
This file includes the backticked content as pre(formatted).

@[:pre](triple_backtick.md)
```

The treatment token ```:pre``` specifies that the included text is to be treated as pre-formatted.

#### Include Via <code>markdown_helper</code>
<details>
<summary>CLI</summary>

```sh
markdown_helper include --pristine includer.md included.md
```

(Option ```--pristine``` suppresses comment insertion.)
</details>
<details>
<summary>API</summary>

```include.rb```:
```ruby
require 'markdown_helper'

# Option :pristine suppresses comment insertion.
markdown_helper = MarkdownHelper.new(:pristine => true)
markdown_helper.include('includer.md', 'included.md')
```

</details>

#### File with Inclusion

Here's the finished file with the included preformatted text:

```included.md```:
```markdown
This file includes the backticked content as pre(formatted).

<pre>
This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
</pre>
```

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
markdown_helper-2.5.4	markdown/use_cases/include/include_text_as_pre/use_case.md
markdown_helper-2.5.3	markdown/use_cases/include/include_text_as_pre/use_case.md
markdown_helper-2.5.2	markdown/use_cases/include/include_text_as_pre/use_case.md
markdown_helper-2.5.1	markdown/use_cases/include/include_text_as_pre/use_case.md
markdown_helper-2.5.0	markdown/use_cases/include/include_text_as_pre/use_case.md
markdown_helper-2.4.0	markdown/use_cases/include/include_text_as_pre/use_case.md
markdown_helper-2.3.0	markdown/use_cases/include_files/include_text_as_pre/use_case.md