https://github.com/maxchang3/hexo-reference-plus

A hexo plugin to support simply reference marked and footnotes by markdown. Auto serial number, tooltip, and more.
https://github.com/maxchang3/hexo-reference-plus

footnotes hexo reference tooltip

Last synced: 21 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/maxchang3/hexo-reference-plus
• Owner: maxchang3
• Created: 2021-09-22T10:20:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-20T10:38:11.000Z (over 2 years ago)
• Last Synced: 2024-12-30T10:41:10.932Z (21 days ago)
• Topics: footnotes, hexo, reference, tooltip
• Language: JavaScript
• Homepage:
• Size: 50.8 KB
• Stars: 13
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hexo-reference-plus

English | [简体中文](https://github.com/MaxChang3/hexo-reference-plus/blob/main/README_CN.md)

GIF Preview

![](https://s3.ax1x.com/2021/09/27/4gfIiD.gif)

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

- [x] auto serial number

- [x] tooltip with tippy.js 

- [x] easy to use  grammar 

- [x] configuration in front-matter for minimize 

Inspried by [hexo-reference](https://github.com/kchen0x/hexo-reference).

## Install

```

yarn add hexo-reference-plus

```

or 

```

npm install hexo-reference-plus

```

[![NPM](https://nodei.co/npm/hexo-reference-plus.png)](https://nodei.co/npm/hexo-reference-plus/)

## Usage

All you need to do is Three steps:

First, set `refplus: true` in your hexo markdown file's front-matter, like

```markdown

---

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.

```yaml

# 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 %}

```