https://github.com/tea3/hexo-include-markdown
Easily load markdownfiles in Markdown .
https://github.com/tea3/hexo-include-markdown
hexo hexo-plugin import include markdown
Last synced: 8 days ago
JSON representation
Easily load markdownfiles in Markdown .
- Host: GitHub
- URL: https://github.com/tea3/hexo-include-markdown
- Owner: tea3
- License: mit
- Created: 2017-06-30T10:57:21.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-08T01:29:17.000Z (almost 9 years ago)
- Last Synced: 2025-09-24T04:30:17.534Z (10 months ago)
- Topics: hexo, hexo-plugin, import, include, markdown
- Language: JavaScript
- Size: 11.7 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-include-markdown
This plugin for [Hexo](https://hexo.io/) can easily load another markdown files in markdown file .
## Document
[Hexoでmarkdownに外部マークダウンを読み込ませるプラグインを作った](https://photo-tea.com/p/17/hexo-include-markdown/)
## Requirements
This plugin supports node.js v4.3 or later. Also , I recommend Hexo v3.2 or later.
## Installation
``` bash
$ npm install hexo-include-markdown --save
```
## Usage
Please add `` in markdown file.
For example, edit the `source/_posts/hello-world.md` as follows.
```
---
title: Hello World
---
## include sample
Please load another markdown file with the following code.
```
Next, please create a new markdown for the template. For example, create `source/_ template/template.md` as follows.
```
### include me ?
Here is the `template.md`'s content . This content is read from an external markdown file.
```
## option
Please set the following options. Please edit `_config.yml`.
```
include_markdown:
dir: source/_template # Base directory of template markdown
verbose : true # If you want to check the path of markdown that use tag , please set the true.
```
## Referenced issue
- [hexo issue 1904](https://github.com/hexojs/hexo/issues/1904)
How do I split a post up into several smaller markdown files?
- [hexo issue 2376](https://github.com/hexojs/hexo/issues/2376)
How to make a home page out of multiple markdown files?
- [hexo issue 2582](https://github.com/hexojs/hexo/issues/2582)
Cache not updating on nested includes
## License
MIT
[Hexo]: http://hexo.io/