micronotes
micronotes is a simple JavaScript plugin that allows you to quickly and easily add beautiful footnote boxes to webpages. Just add the script to any HTML page, and you can easily add footnote boxes anywhere on the page. Hovering over a footnote number will display its content, and you can click on any number to see the corresponding footnote in an automatically generated listing that will be added to the end of the page.
Just a fun weekend project. Not to be confused with Microsoft.
Usage
Installation
To add micronotes to any page on your website, simply add the following <script> tag to the HTML of the page at the bottom of the
section.
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/generic-github-user/micronotes@v1.0/micronotes.js"></script>
If using plain HTML, you will need to add the script to any page that you want to add footnotes to. Alternatively, add it to a PHP functions file or similar file that loads content that must be added to every page on a website - this way, you only need to add the script once.
Adding Footnotes
By default, footnotes can be added using the {note} and {/note} tags - just put whatever HTML you want in between those two tags, and it will automatically be made into a gorgeous, responsive footnote.
Note: the {note} syntax will be depreciated in version 1.5, which will introduce a custom HTML tag, <note>. From then on, the <note> tag should be used instead of {note}. However, {note} will continue to be supported for at least one year after the release of v1.5.
Requirements
None! micronotes was designed to work without any dependencies or requirements of any kind - just drop it into your web page, and it'll work. One of the issues I had with some other JavaScript footnote plugins and libraries was that they needed jQuery or other libraries to be loaded in order to work. Something as simple as adding footnotes to a web page should not require entire libraries - it should be simple, lightweight, and independent.
Other Information
Issues
Please submit any and all issues you have with micronotes to the issues page. I'll try to help you resolve it as soon as possible, or recommend an alternative solution if necessary.
If you want a feature added, submit that to the issues page too. I can't guarantee that everything people ask for will be added, but I'll read everything you submit.
Alternatives
Some other great options for adding footnotes to a website include Lukas Mathis' footnotes script from ignore the code and Matt Gemmell's Footnotes Popover script. Even just using a
tag with a superscript element can work, but it's not extremely elegant. <a rel="noreferrer nofollow" target="_blank" href="https://www.cssscript.com/">CSS Script</a> also has a <a rel="noreferrer nofollow" target="_blank" href="https://www.cssscript.com/sticky-footnote-generator/">footnote generator</a>, in case you're looking for something that doesn't require adding any scripts to your code.</p>
<p>If you want to add footnotes to a <a rel="noreferrer nofollow" target="_blank" href="https://wordpress.org/">WordPress</a> website, I recommend the <a rel="noreferrer nofollow" target="_blank" href="https://wordpress.org/plugins/easy-footnotes/">Easy Footnotes</a> plugin, since JavaScript doesn't work too well with WordPress.</p>
<p>There really aren't that many options when it comes to adding clean, modern footnotes to a web page, though. The issue I had with most of the existing solutions was that they looked outdated, were missing important features, or relied on jQuery or other JavaScript libraries. Hopefully I was able to improve upon the existing options, and maybe someone will find this little project useful.</p>
<h2>Technical Details</h2>
<p>How it works.</p>
<h3>Footnote Styling</h3>
<p>All of the CSS styling information used to add custom styling to footnotes is automatically added to the header section by the micronotes script. This includes classes for footnote numbers and boxes, as well as some layout information.</p>
<pre><code class="language-css">* {
box-sizing: border-box;
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
}
.number {
text-decoration: none;
color: #2b5cad;
transition: color 1s ease;
}
.number:hover {
color: #6799ea;
transition: color 1s ease;
}
.number:active {
color: #96beff;
transition: color 0.1s ease;
}
.note {
background-color: #efefef;
border-radius: 5px;
box-shadow: 4px 4px 10px 2px #999;
opacity: 0;
padding: 1vw;
margin: 0.1vw;
position: absolute;
visibility: hidden;
transition: background-color 1s ease 0.25s, border-radius 1s ease 0.25s, box-shadow 1s ease 0.25s, opacity 1s ease, visibility 0s ease 1s;
}
.note:hover {
background-color: #ffffff;
border-radius: 15px;
opacity: 1;
visibility: visible;
transition: background-color 1s ease 0s, border-radius 1s ease 0s, box-shadow 1s ease 0s, opacity 1s ease;
}</code></pre></div>
</div>
<div class="footer">
<ul class="body">
<li>© <script>
document.write(new Date().getFullYear())
</script> Githubissues.</li>
<li>Githubissues is a development platform for aggregating issues.</li>
</ul>
</div>
<script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script>
<script src="/githubissues/assets/js.js"></script>
<script src="/githubissues/assets/markdown.js"></script>
<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script>
<script>
hljs.highlightAll();
</script>
</body>
</html>