# docsify-include-template

> Docsify plugin. It includes template files.

Latest version **1.1.1** (published 2019-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install docsify-include-template
pnpm add docsify-include-template
yarn add docsify-include-template
bun add docsify-include-template
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-02-07 |
| First published | 2019-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Masataka Kishida |
| Maintainers | kissybnts |
| Keywords | docsify, include, template, plugin |

## Links

- npm: https://www.npmjs.com/package/docsify-include-template
- Repository: https://github.com/kissybnts/docsify-include-template
- Homepage: https://github.com/kissybnts/docsify-include-template#readme
- Issues: https://github.com/kissybnts/docsify-include-template/issues
- npm.io page: https://npm.io/package/docsify-include-template

## Recent versions

- 1.1.1 (latest) — 2019-02-07
- 1.1.0 — 2019-02-05
- 1.0.1 — 2019-02-04
- 1.0.0 — 2019-02-04

## README

# Docsify include template

[Docsify](https://github.com/docsifyjs/docsify/) plugin. It loads variables from json file specified.

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

## Installation

Put below script into `index.html`.
```html
<script src="//unpkg.com/docsify-include-template/dist/docsify-include-template.js"></script>
```

## Usage

### Basic usage

This plugin will replace `%[{ filename }]%` with the contents of the specified file.  

If your directory is like below and you want to include `template.md` and `hoge.md` into `README.md`,  
```
.
├── index.html
├── README.md
├── template.md
├── templates
│   └── hoge.md
└── .nojekyll
```

the, you can write like below.  
```
# README.md

%[{ template.md }]%

%[{ templates/hoge.md }]%
```

\* Please note that `filename` must include extension. e.g. `template.md`.  

### Docsify ignore

If you don't want to add subheaders witch are in template file, you can tell it to this plugin.
```
%[{ template.md:ignore }]%
```
This plugin will append `{docsify-ignore}` to the headers which are in the template file.

### Advanced usage

You can pass variables to template file.  

Full syntax in a file which includes template files is like this.
```markdown
%[{
<!-- f:filename -->
<!-- o:ignore -->
<!-- v:s:variablaname -->
Something you need
<!-- v:e:variablaname -->
}]%
```

- `<!-- f:filename -->`
    - This is required
    - It specifies the filename.  `filename` must include extension. e.g. `template.md`.
- `<!-- o:ignore -->`
    - This is optional
    - If you put this, this plugin will add `{docsify-ignore}` to the headers which are in the template file.
- `<!-- v:s:variablaname -->` `<!-- v:e:variablaname -->`
    - Set of these comments is required, at least one set
    - `v:s` represents the starting point of the variable
    - `v:e` represents the end point of the variable
    - You can put any markdown syntax between `v:s` and `v:e`, and it will be inserted into the template file 
    - `variablename` should not be duplicated within one `%[{  }]`

In template file, you can write `<!-- v:variablename -->` and it will be replaced by the variable. 

#### Example

If your `README.md` file which includes template file is like below, 
```markdown:README.md
# README.md

%[{
<!-- f:template.md -->
<!-- o:ignore -->
<!-- v:s:hoge -->
This part will be inserted into `template.md` file.  
You can use any markdown syntax.  
<!-- v:e:hoge -->
<!-- v:s:piyo -->
- piyo
- piyopiyo
- **piyo!**
<!-- v:e:piyo -->
}]%
```

And your template file is like below,

```markdown:template.md
## Hoge

<!-- v:hoge -->

## Piyo

<!-- v:piyo -->
```

Then, `README.md` will be like this.

```markdown:README.md
# README.md

## Hoge {docsify-ignore}

This part will be inserted into `template.md` file.  
You can use any markdown syntax.

## Piyo {docsify-ignore}

- piyo
- piyopiyo
- **piyo!**
```

---
_Source: https://npm.io/package/docsify-include-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._