Skip to content

Markdown tool directory

Matt Cone edited this page Jul 29, 2020 · 22 revisions

The Markdown tool directory is a list of Markdown applications. Each page provides a brief overview of the application and a list of the Markdown syntax elements that are supported.

Ethics statement

Creating and curating this list has been a labor of love. I don't accept compensation or gifts in exchange for adding applications to this directory. I'm not affiliated with any of the developers of these applications. When necessary, I purchase licenses and subscriptions for these applications. Of course, The Markdown Guide is an open source project and I welcome pull requests from readers. Developers are welcome to submit information about their applications.

List of tools that (may) need to be documented

The Markdown tool directory is a work in progress. I've compiled a list of some applications that I think might need to be documented. This is not a comprehensive list! Feel free to add other tools.

How to test an application

This is currently pretty terrible, but I copy and paste the source of the README from my markdown-test repository into the application and see what the rendered output looks like. Something I've noticed is that different file formats (HTML/PDF/etc.) can render different output, so be sure to test and verify each of the application's export options.

Creating a page for an application

I really need to make this easier. Sorry. It's currently a very manual process. What I do is duplicate an existing tool page and work from that. You'll need to add an icon (required) and screenshot (optional) for the application.

Things to note:

  • Check that the application's description in the YAML fits in the box on the application directory home page — you'll need to preview the site locally or check the Netlify staging link when you open the pull request.
  • The table is HTML, so you can't use Markdown in the source there. Use HTML.
  • You have to manually change the cell color to match the cell status (Yes/No/Partial). See existing pages.
  • Keep the marketing text to a minimum and make sure it doesn't sound like an advertisement. People want to know briefly what the application does and whether or not it fits their needs. They can always visit the application's website if they want more information.

Open a pull request and I'll proofread it. If you need help, contact me! Thanks!

Clone this wiki locally