<commit_before>---
layout: plugin-documentation.html.ejs
title: AskashaCMS Footnotes plugin documentation
---

Footnotes are widely used in writing to cite references or add additional comments.  The AkashaCMS Footnotes implementation is inspired by Wikipedia in that the footnote inserts an in-page link at the footnote's location, and generates a list of citations at the bottom of the page.  Like this: <footnote name="AkashaCMS" href="https://akashacms.com" title="Build the website of your dreams"/>

The code to generate that footnote:

```
<footnote name="AkashaCMS" href="https://akashacms.com" title="Build the website of your dreams"/>
```

# Installation

Add the following to `package.json`

```
"dependencies": {
    ...
    "akashacms-footnotes": "akashacms/akashacms-footnotes#akasharender",
    ...
}
```

The AkashaRender version of `akashacms-footnotes` has not been published to `npm` yet, and therefore must be referenced this way.

Once added to `package.json` run: `npm install`

# Configuration

Add the following to `config.js`

```
config
    ...
    .use(require('akashacms-footnotes'))<commit_msg>Update documentation for 0.6<commit_after>---
layout: plugin-documentation.html.ejs
title: AskashaCMS Footnotes plugin documentation
---

Footnotes are widely used in writing to cite references or add additional comments.  The AkashaCMS Footnotes implementation is inspired by Wikipedia in that the footnote inserts an in-page link at the footnote's location, and generates a list of citations at the bottom of the page.  Like this: <footnote name="AkashaCMS" href="https://akashacms.com" title="Build the website of your dreams"/>

The code to generate that footnote:

```
<footnote name="AkashaCMS" href="https://akashacms.com" title="Build the website of your dreams"/>
```

# Installation

Add the following to `package.json`

```
"dependencies": {
    ...
    "akashacms-footnotes": ">=0.6",
    ...
}
```

Once added to `package.json` run: `npm install`

# Configuration

Add the following to `config.js`

```
config
    ...
    .use(require('akashacms-footnotes'))
{'fraction_non_alphanumeric': 0.1126491646778043, 'fraction_numerical': 0.0019093078758949881, 'mean_word_length': 4.319796954314721, 'pattern_counts': {'":': 4, '<': 7, '<?xml version=': 0, '>': 8, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '467372', 'n_tokens_mistral': 639, 'n_tokens_neox': 597, 'n_words': 227}