diff --git a/README.md b/README.md index e897c4f..e9ac627 100644 --- a/README.md +++ b/README.md @@ -232,6 +232,78 @@ Once installed the tests can be run from the project root using: New test cases can easily be added. Create a markdown file (ending in `.md`) which contains the markdown to test. Create a `.html` file of the exact same name. It will automatically be tested when the tests are executed with `mocha`. +Creating Markdown Extensions +---------------------------- + +A showdown extension is simply a function which returns an array of extensions. Each single extension can be one of two types: + + - Language Extension -- Language extensions are ones that that add new markdown syntax to showdown. For example, say you wanted `^^youtube http://www.youtube.com/watch?v=oHg5SJYRHA0` to automatically render as an embedded YouTube video, that would be a language extension. + - Output Modifiers -- After showdown has run, and generated HTML, an output modifier would change that HTML. For example, say you wanted to change `