README.md

hexo-tag-github-code

Insert code from GitHub when static files are generated.

Not embed.

Install

$ npm install hexo-tag-github-code --save

Usage

{% ghcode URL [start_line stop_line] [options] %}

Support URL

GitHub / Gist

• URL of each file page as below
  • https://github.com/nkmk/hexo-tag-github-code/blob/master/index.js
  • https://gist.github.com/nkmk/d60cdbcffdb60d624ac01871543f79a2
  • https://gist.github.com/nkmk/d60cdbcffdb60d624ac01871543f79a2#file-sample-py
• URL links to raw file as below
  • https://github.com/raw/nkmk/hexo-tag-github-code/master/index.js
  • https://gist.githubusercontent.com/nkmk/d60cdbcffdb60d624ac01871543f79a2/raw/e7528c00addcdd0b4d00cb9bbd8d225cc132fbfc/sample.py

Other site

If URL links to raw file, it will work.

Options

Set like as {cap:false,re:true,lang:javascript}. Please do NOT insert any spaces.

option	description	default
cap	true: show caption false: no caption	true
re	true: the first line number restart from 1 false: the first line number start from original code number	false
lang	the language to use for highlighting	the extension of the file

Config setting

You can change default settings in _config.yml as below.

github_code:
  cap: false
  re: true

Examples

Full code

{% ghcode https://github.com/nkmk/hexo-list-related-posts/blob/master/lib/index.js %}

Selected lines

Insert code from line 17 to line 22.

{% ghcode https://github.com/nkmk/hexo-list-related-posts/blob/master/lib/index.js 17 22 %}

Without caption

{% ghcode https://github.com/nkmk/hexo-list-related-posts/blob/master/lib/index.js 17 22 {cap:false} %}

Restart the first line number from 1

{% ghcode https://github.com/nkmk/hexo-list-related-posts/blob/master/lib/index.js 17 22 {re:true} %}

Force the language highlighting to HTML for a JavaScript file

{% ghcode https://github.com/nkmk/hexo-list-related-posts/blob/master/lib/index.js 17 22 {lang:html} %}