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

```includee.md```:
```markdown
Text to be included.
```

#### Includer File

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

#### CLI

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

##### Command

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

#### API

You can use the API to perform the inclusion.

##### Ruby Code

```ruby
require 'markdown_helper'

markdown_helper = MarkdownHelper.new
markdown_helper.include(includer.md, included.md)
```

#### File with Inclusion and Added Comments

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

The file path for the included file is relative to the .git directory.

Version data entries

5 entries across 5 versions & 1 rubygems

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