Sha256: 1ad7a0cb9c980d275f7c8664ce0bcaa83aa62c6cfed64194e4843bdff92be8d5

Contents?: true

Size: 813 Bytes

Versions: 13

Compression:

Stored size: 813 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

@[markdown](includee.md)

#### Includer File

@[markdown](includer.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

@[markdown](included.md)

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

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
markdown_helper-2.5.4 markdown/use_cases/include/include_with_added_comments/use_case_template.md
markdown_helper-2.5.3 markdown/use_cases/include/include_with_added_comments/use_case_template.md
markdown_helper-2.5.2 markdown/use_cases/include/include_with_added_comments/use_case_template.md
markdown_helper-2.5.1 markdown/use_cases/include/include_with_added_comments/use_case_template.md
markdown_helper-2.5.0 markdown/use_cases/include/include_with_added_comments/use_case_template.md
markdown_helper-2.4.0 markdown/use_cases/include/include_with_added_comments/use_case_template.md
markdown_helper-2.3.0 markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
markdown_helper-2.2.0 markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
markdown_helper-2.1.0 markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
markdown_helper-2.0.0 markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
markdown_helper-1.9.9 markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
markdown_helper-1.9.5 markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
markdown_helper-1.9.0 markdown/use_cases/include/include_with_added_comments/use_case_template.md