This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/README.md

18 lines
1.3 KiB
Markdown
Raw Normal View History

![footnotes](https://raw.githubusercontent.com/media-competence-institute/footnotes/master/assets/footnotes.png)
**footnotes** WordPress Plugin
#### this plugin intends to be straight forward and customizable at the same time ####
**footnotes** gives you the ability to display decently-formated footnotes on your WordPress Pages or Posts. **footnotes** aims to be the all-in-one solution that ships with a set of sane defaults (those footnotes we know from offline publishing) but also give the user control over how their **footnotes** are being displayed.
![screenshot](https://raw.githubusercontent.com/media-competence-institute/footnotes/master/assets/screenshot-example.jpg)
The syntax is based on the common DokuWiki syntax for footnotes. So, to include a footnote with the text "with a footnote," you use:
Your awesome text((with a footnote))
And that's all you need to do. When you add a footnote, **footnotes** will create a note marker at the point that the foonote appears in the text, and includes the text of the footnote in a styled list of notes down the page. Using `((` + `))` is the default. You can decide on what the shortcode for **footnotes** should be.
This plugin (once released on wordpress.org) will give you full customizability while being shipped with a set of sane defaults.