0.0
No commit activity in last 3 years
No release in over 3 years
Rack middleware to insert text comments into pages. First created to be used with jlong's serve, but should work with pretty much every rack app
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
 Project Readme

Rack FootNotes

Rack::FootNotes is a very simple middleware I coded to add footnotes to prototypes created with jlong/serve

Usage

Create a notes folder in your serve project's root. Add a text file with notes for every route you want to display notes in. I.e: if you want to show notes for http://0.0.0.0:4000/foo/bar/, add them to notes/foo/bar.txt

Then, load Rack::FootNotes in your config.ru:

gem 'rack-footnotes'
require 'rack/footnotes'
use Rack::FootNotes, {
  :notes_path => 'notes',
  :extra_css => "text-align: center;"
}

There are three options:

  • :notes_path, the folder where you want to store your notes
  • :css, the CSS for the div containing the notes (don't change this unless necessary)
  • :extra_css, styles that will be added to the default CSS. Use it to change the background color, font-face, etc...