Poppins
Poppins formats Markdown files to ensure that reference links are numbered and appear in numerical order. Currently, this is a seriously basic tool. Still, it does what I needed, and I hope to expand it. Poppins was inspired by Dr. Drang's script for tidying reference links.
Installation
Add this line to your application's Gemfile:
gem 'poppins'
And then execute:
$ bundle
Or install it yourself as:
$ gem install poppins
Usage
Poppins: a Markdown cleaner and formatter
Usage: poppins [options] <filename>
Examples:
poppins ./README.md
poppins --output 'output.md' ./input.md
Options:
-o, --output [FILE] Write the clean, formatted Markdown to FILE.
-h, --help Show this message
-v, --version Show version
Roadmap
Poppins is intended to be similar to formd, but with easier integration with Ruby projects. Also, I would like to add the ability to insert reference links they way Dr. Drang describes here and here.
It would also be really awesome if we could re-flow paragraph text and wrap it at user-specified column lengths.
Currently, Poppins doesn't handle implicit reference links. Those are links that look like this or perhaps like this.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request