Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1 KB

README.md

File metadata and controls

45 lines (29 loc) · 1 KB

Introduction

This is a hexo tag plugin which allows you to embed an image stored on your Github repository with specific branch.

Hexo Version

For 2.x, use version 0.0.1 of this plugin. Version 0.1.x and beyond only support Hexo v3.x.

Installation

To install, run the following command in the root directory of hexo:

npm install hexo-tag-githubimage --save

And add this plugin in your _config.yml.

plugins:
  - hexo-tag-githubimage

Usage

{% ghimg imageId [class1,class2] [JSONImageAttibutes] %}

Example:

{% ghimg /wizicer/IcerSite/dev/source/images/icer.png center,custom_class1,custom_class2 {"width":450,"height":450,"alt":"Image Alt"} %}

Will output:

<img width="450" height="450" alt="Image Alt" src="https://raw.githubusercontent.com/wizicer/IcerSite/dev/source/images/icer.png" class="center custom_class1 custom_class2">

IMPORTANT

Classes must be comma-separated and without spaces. Same as JSONImageAttibutes.