Sha256: 637dfa1ae2b5c8de60321d54c26c5f3c1b40c0955078870c34bc320452648c3a

Contents?: true

Size: 851 Bytes

Versions: 1

Compression:

Stored size: 851 Bytes

Contents

### Include with Added Comments

By default (that is, without option ```--pristine```) file inclusion adds comments that:

* Identify the includer file.
* Identify each includee file.

#### Includee File

<code>includee.md</code>
```markdown
Text to be included.
```

#### Includer File

<code>includer.md</code>
```markdown
@[:markdown](includee.md)
```

#### Inclusion Command

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

#### File with Inclusion and Added Comments

<code>included.md</code>
```markdown
<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE ./includee.md -->
Text to be included.
<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE ./includee.md -->
<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
markdown_helper-1.8.0 markdown/use_cases/include/include_with_added_comments/include_with_added_comments.md