hexo-include
Advanced tools
Comparing version 1.0.1 to 1.0.2
{ | ||
"name": "hexo-include", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "A Hexo plugin for including raw content of any text file into a post", | ||
"main": "index.js", | ||
"license": "MIT", | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/pipirt/hexo-include.git" | ||
"url": "git+https://github.com/pirtleshell/hexo-include.git" | ||
}, | ||
"author": { | ||
"name": "Robert Pirtle", | ||
"email": "astropirtle@gmail.com", | ||
"url": "pirtle.xyz" | ||
}, | ||
"main": "lib/index.js", | ||
"keywords": [ | ||
@@ -16,8 +22,18 @@ "hexo", | ||
], | ||
"author": "Robert Pirtle <astropirtle@gmail.com> (http://pirtle.xyz)", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/pipirt/hexo-include/issues" | ||
}, | ||
"homepage": "https://github.com/pipirt/hexo-include#readme" | ||
"homepage": "https://github.com/pipirt/hexo-include#readme", | ||
"devDependencies": { | ||
"babel-register": "^6.16.3", | ||
"chai": "^3.5.0", | ||
"eslint": "^3.7.1", | ||
"eslint-config-hexo": "^1.0.3", | ||
"hexo": "^3.2.2", | ||
"hexo-fs": "^0.1.6", | ||
"mocha": "^3.1.1" | ||
}, | ||
"scripts": { | ||
"test": "test/test.js" | ||
} | ||
} |
# hexo-include | ||
--- | ||
A Hexo plugin for including the raw content of a text file into a post. Easily insert pre-written HMTL, JS, or _any_ text file into the body of your post or page. | ||
## Install | ||
--- | ||
``` | ||
$ npm install --save 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 | ||
--- | ||
All file paths are relative to your `source` directory. | ||
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. | ||
``` | ||
@@ -18,4 +12,14 @@ {% 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 | ||
MIT (c) 2016 Robert Pirtle. |
Sorry, the diff of this file is not supported yet
5620
9
101
25
7