docsify-footnote/README.md

<div align="center">

<div align="center">

# docsify-footnote

[![GitHub Release](https://img.shields.io/github/release/Robert-Du0001/docsify-footnote.svg)](https://github.com/Robert-Du0001/docsify-footnote/releases) [![NPM Release](https://img.shields.io/npm/v/docsify-footnote.svg)](https://www.npmjs.com/package/docsify-footnote)

[English](/README.md) | [简体中文](/README.zh-CN.md)

A [docsify.js](https://docsify.js.org) plugin for footnote in markdown.
</div>

## Example

You just need to import this JS script: 

```js
<script src="//cdn.jsdelivr.net/npm/docsify-footnote/dist/docsify-footnote.min.js"></script>
```

Then, enjoy it:

```markdown
tf[^1]

[^1]: Test File

or

tf^[Test File]

or

tf1[^2]

[^2]: Test File1
```

![demo-1](/docs/assets/imgs/example.png)

## Configuration 

```javascript
window.$docsify = {
  docsifyFootnote: {
    // Set to true to hide the sub-anchor numbering.
    // https://github.com/Robert-Du0001/docsify-footnote/pull/5
    hideSubAnchor: true,
  }
}
```

## License
[MIT License](LICENSE)