# hexo-include

**Repository Path**: lidongai/hexo-include

## Basic Information

- **Project Name**: hexo-include
- **Description**: A Hexo plugin for including raw content of any text file into a post
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-17
- **Last Updated**: 2021-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# hexo-include

A [Hexo](https://github.com/hexojs/hexo) plugin for including the raw content of a text file into a post directly from its markdown. Easily insert pre-written HMTL, JS, or the contents of _any_ text file into the body of your post or page.

## Usage

Insert the following into the post's markdown where you want the contents of the external file inserted. All file paths are relative to your `source` directory.
```
{% include path/to/file.bar %}
```

## Install

Install with [npm](https://www.npmjs.com/) from the base directory of your Hexo site:

```
$ npm install --save --only=prod hexo-include
```

The `--only=prod` ensures that the development dependencies are not installed. If you want to run the tests, remove this flag. More info [here](https://docs.npmjs.com/cli/install).

## License

MIT (c) 2016 Robert Pirtle.