blackfriday v2.0.0 Release Notes

Release Date: 2017-08-11 // over 2 years ago
  • 🔖 Version 2 of Blackfriday is a major overhaul of the API. Feature-wise nothing has changed, but the entire set of types, functions and constants has changed. This was done to make the API have more idiomatic Go look-and-feel, and fix a few bugs inherent in the legacy C-like interface. As a bonus, Blackfriday has become more flexible for extension.

    Highlights:

    • The most common entry point has been simplified. The vast majority of users can now call Run to get what they want:

      outputBytes := blackfriday.Run(inputBytes)

    • Writing your own renderer has become much easier.

    • 0️⃣ It's become very easy to write an extension to an existing renderer, customizing one aspect or another, and leaning back to the default behavior.

    • 📜 You can now parse the Markdown document and obtain the syntax tree. You can manipulate the tree before rendering, or you can use it for data extraction from the Markdown documents.

    • 📚 To get all of the above working, documentation has been improved.