formd—A Markdown formatting tool:
Markdown is a text-to-HTML conversion tool for web writers developed by John Gruber. The main page and accompanying docs provide a comprehensive overview on how to implement the Markdown syntax. The Markdown Dingus is also a useful resource for learning Markdown.
formd is a tool for (for)matting (m)ark(d)own that allows rapid conversion between the two styles of Markdown links—inline and referenced. Why do you need
formd? Inline Markdown is difficult to read, but useful for writing and editing because the linked text and URL are adjacent to the words you are writing. Referenced Markdown is awkward while writing because it requires jumping between text links within text and the reference section at the bottom of a document. However, referenced Markdown is the superior syntax for reading because URLs do not breakup the flow of words or sentences.
formd provides the best of both worlds by allowing users to toggle Markdown formats between inline while writing and referenced while reading.
- Python 2.7
Download formd and place it somwhere in your path:
git clone https://github.com/drbunsen/formd.git ~/bin/
There are two command line option for
- To generate referenced Markdown use the
- To generate inline Markdown use the
A simple working example of
cat ugly_markdown_file.md | formd -r > reference_formatted_file.md
For more information on
formd see this post for additional usage examples and a video demonstration.