Draft release notes and doc updates for 2.0.0 release (#3539479) · Issues · project / markdown_easy

Draft release notes and doc updates for 2.0.0 release

>>> [!note] Migrated issue   Reported by: [ultimike](https://www.drupal.org/user/51132) Related to !26 >>> The 2.0.0 version will require solid release notes and some documentation updates. I'll use this issue to keep track of everything. <h3>Summary</h3> This release has new functionality and a new (simpler) default recommended configuration. When upgrading from Markdown Easy 1.x, please be sure to review the Remove/lesson dependency on "Convert line breaks into HTML" section below. Warning: if you have an implementation of <code>hook_markdown_easy_config_modify()</code> it will need to be modified - see below for details. <a href="https://git.drupalcode.org/project/markdown_easy/-/work_items/3493938" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/markdown_easy/-/work_items/3493938</a> <ul> <li>Documentation updated - see <a href="https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/general-usage#configuration">https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/general-usage#configuration</a> <a href="https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/advanced-configuration#s-2x-branch">https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/advanced-configuration#s-2x-branch</a></li> <li>README.md updated</li> <li>Release notes text: This release includes a new Markdown Easy "flavor" - "Markdown Smörgåsbord" contains everything in the "GitHub-flavored Markdown" plus support for footnotes and description lists. The way that version 1.x implemented <code>hook_markdown_easy_config_modify()</code> was bad. So very bad (because it would force the developer to recreate the entire converter - including the extensions - in the hook's implementation.) So, the hook was modified to fire a bit earlier and its input parameter was changed from the <code>$converter</code> to just the <code>$config</code> array. This is a breaking change (so sorry!) for anyone who has already implemented this hook, so if you implemented this hook, you'll need to update it. See the <code>markdown_easy.api.php</code> file in the codebase for additional details.</li> </ul> <a href="https://git.drupalcode.org/project/markdown_easy/-/work_items/3530290" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/markdown_easy/-/work_items/3530290</a> <ul> <li>Documentation updated - see <a href="https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/general-usage#configuration">https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/general-usage#configuration</a> and </li> <li>README.md updated (as part of this issue's MR.)</li> <li>Release notes text: This version drops the requirement that the "Convert line breaks into HTML" text filter be enabled when using the Markdown Easy text filter. When upgrading from the 1.x branch, you can either choose to keep the "Convert line breaks into HTML" text filter enabled or you can disable it and add <code></code> and <code> </code> to the list of tags in the "Limit allowed HTML tags and correct faulty HTML" filter configuration. The second option is recommended.</li> </ul> <a href="https://git.drupalcode.org/project/markdown_easy/-/work_items/3530906" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/markdown_easy/-/work_items/3530906</a> <ul> <li>No documentation updates necessary.</li> <li>No README.md updates necessary.</li> <li>Release notes text: This version improves the feedback provided to site builders regarding the recommended tags for the "Limit allowed HTML tags and correct faulty HTML" filter depending on the Markdown Easy flavor selected. </li> </ul> <a href="https://git.drupalcode.org/project/markdown_easy/-/work_items/3531327" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/markdown_easy/-/work_items/3531327</a> <ul> <li>Documentation updated - see <a href="https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/advanced-configuration#s-power-user-modes-version-20x-only">https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/advanced-configuration#s-power-user-modes-version-20x-only</a></li> <li>README.md updated.</li> <li>Release notes text: This version introduces two new "power user" settings that can be set via configuration (no admin UI is provided) to disable all filter validation related to Markdown Easy and to configure the Markdown process to skip HTML input stripping. See the <a href="https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/advanced-configuration#s-power-user-modes-version-20x-only">Advanced Configuration documentation</a> for details.</li> </ul> <a href="https://git.drupalcode.org/project/markdown_easy/-/work_items/3537860" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/markdown_easy/-/work_items/3537860</a> <ul> <li>No documentation updates necessary.</li> <li>No README.md updates necessary.</li> <li>Release notes text: Improves the help text provided when configuring the Markdown Easy text filter.</li> </ul> <a href="https://git.drupalcode.org/project/markdown_easy/-/work_items/3531110" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/markdown_easy/-/work_items/3531110</a> <ul> <li>No documentation updates necessary.</li> <li>No README.md updates necessary.</li> <li>Release notes text: Full support for Markdown tables added to "Github-flavored Markdown" and "Markdown Smörgåsbord" Markdown Easy flavors.</li> </ul> As usual, I'll be using the most-excellent <a href="https://github.com/mglaman/drupalorg-cli">drupalorg CLI tool</a> to generate the scaffolding for the release notes before tweaking it with "Release notes text" from above (as well as writing a summary.) Finally, I'll need to update <a href="https://www.drupal.org/project/markdown_easy">the project page</a> with the following changes: Change It is strongly suggested to utilize the "Limit allowed HTML tags and correct faulty HTML" and "Convert line breaks into HTML" Drupal core text filters in conjunction with this module. to It is required to utilize the "Limit allowed HTML tags and correct faulty HTML" text filters in conjunction with this module, see the <a href="https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/markdown-easy/advanced-configuration">Advanced configuration docs</a> to remove this requirement. Remove IMPORTANT - Enable and configure the "Convert line breaks into HTML " filter to run after the Markdown Easy filter and the "Limit allowed HTML tags and correct faulty HTML" filter. For best results, at a minimum, text formats utilizing the Markdown Easy filter should be configured as follows: (and the image that follows.) Add Warning: version 2.x includes a breaking change if you implemented <code>hook_markdown_easy_config_modify()</code> - be sure to read the release notes for details.

issue