Sha256: e01bd653a36f1d1a094e0b5a0f04f5bc1c92e4d83c1ebd8ef2b4ae1ea27e12e5

Contents?: true

Size: 1.26 KB

Versions: 6

Compression:

Stored size: 1.26 KB

Contents

### Nest Inclusions

An included markdown file can itself include more files.

#### File To Be Included

```includee.md```:
```markdown
Text for inclusion, and a nested inclusion.

@[:markdown](nested_includee.md)
```

#### File For Nested Inclusion

```nested_includee.md```:
```markdown
Text for nested inclusion.
```

#### Includer File

```includer.md```:
```markdown
File to do nested inclusion.

@[:markdown](includee.md)
```

#### CLI

You can use the command-line interface to perform the inclusion.

##### Command

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

(Option ```--pristine``` suppresses comment insertion.)

#### API

You can use the API to perform the inclusion.

##### Ruby Code

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

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

##### Command

```sh
ruby include.rb
```

#### File with Inclusion

Here's the finished file with the inclusion and nested inclusion:

```included.md```:
```markdown
File to do nested inclusion.

Text for inclusion, and a nested inclusion.

Text for nested inclusion.
```

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
markdown_helper-2.2.0 markdown/use_cases/include_files/nest_inclusions/use_case.md
markdown_helper-2.1.0 markdown/use_cases/include_files/nest_inclusions/use_case.md
markdown_helper-2.0.0 markdown/use_cases/include_files/nest_inclusions/use_case.md
markdown_helper-1.9.9 markdown/use_cases/include_files/nest_inclusions/use_case.md
markdown_helper-1.9.5 markdown/use_cases/include_files/nest_inclusions/use_case.md
markdown_helper-1.9.0 markdown/use_cases/include/nest_inclusions/use_case.md