Skip to content

A hexo plugin to support simply reference marked and footnotes by markdown. Auto serial number, tooltip, and more.

Notifications You must be signed in to change notification settings

maxchang3/hexo-reference-plus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hexo-reference-plus

English | 简体中文

GIF Preview

A hexo plugin to support reference and footnotes marked by markdown in your hexo blog

  • auto serial number

  • tooltip with tippy.js

  • easy to use grammar

  • configuration in front-matter for minimize

Inspried by hexo-reference.

Install

yarn add hexo-reference-plus

or

npm install hexo-reference-plus

NPM

Usage

All you need to do is Three steps: First, set refplus: true in your hexo markdown file's front-matter, like

---
title: hexo-reference-plus
date: 2021-09-24 15:49:08
refplus: true
---

Second, mark the references in the end, and assign each reference an alias(generally recommend do not contain serial number) like:

{% references %}
[mcf-2021]  Max C. Foo.  A way to write an article.[J] Journal of Kelaideng University Samwin School. 2021.3 300-321.
{% endreferences %}

Third, mark the alias in the area you want, like:

So here is the way what Max C. Foo(2021){% ref mcf-2021 %} do.

Note: You need to use the alias before the reference area

that's it.

Config

Add this config in your _config.yml to swtich the tippy js.

# hexo-reference-plus
refplus:
  tippy: true

use option hide in references tag to hide this area.

{% references hide %}
[mcf-2021]  Max C. Foo.  A way to write an article.[J] Journal of Kelaideng University Samwin School. 2021.3 300-321.
{% endreferences %}

About

A hexo plugin to support simply reference marked and footnotes by markdown. Auto serial number, tooltip, and more.

Topics

Resources

Stars

Watchers

Forks