From f121e0816571ef2eadfa8cc6ba87fe169736a6e1 Mon Sep 17 00:00:00 2001 From: facelessuser Date: Tue, 11 Aug 2020 08:50:27 -0600 Subject: [PATCH] Rework release notes into separate pages --- docs/src/markdown/about/changelog.md | 10 +- docs/src/markdown/about/release.md | 205 ------------------------ docs/src/markdown/about/releases/6.0.md | 56 +++++++ docs/src/markdown/about/releases/7.0.md | 68 ++++++++ docs/src/markdown/about/releases/8.0.md | 110 +++++++++++++ docs/src/mkdocs.yml | 5 +- docs/theme/announce.html | 2 +- mkdocs.yml | 5 +- pymdownx/__meta__.py | 2 +- 9 files changed, 249 insertions(+), 214 deletions(-) delete mode 100644 docs/src/markdown/about/release.md create mode 100644 docs/src/markdown/about/releases/6.0.md create mode 100644 docs/src/markdown/about/releases/7.0.md create mode 100644 docs/src/markdown/about/releases/8.0.md diff --git a/docs/src/markdown/about/changelog.md b/docs/src/markdown/about/changelog.md index 5227d520d..4e22995d8 100644 --- a/docs/src/markdown/about/changelog.md +++ b/docs/src/markdown/about/changelog.md @@ -2,7 +2,7 @@ ## 8.0 -Please see [Release Notes](./release.md#upgrading-to-80) for details on upgrading to 8.0. +Please see [Release Notes](./releases/8.0.md#8.0) for details on upgrading to 8.0. - **NEW**: Added SaneHeaders extension. - **NEW**: SuperFences \& InlineHilite: gracefully handle failing custom formatters and/or validators. Users should add @@ -18,8 +18,8 @@ Please see [Release Notes](./release.md#upgrading-to-80) for details on upgradin attributes. JavaScript highlighter options should be defined in the brace header form with `attr_list` enabled in order to generate appropriate, compatible HTML with the chosen JavaScript highlighter. - **NEW**: SuperFences: backwards incompatible changes where made to custom fence API. See - [Release Notes](./release.md#upgrading-to-80) for instructions on how to migrate to the new API. Some temporary - support for most of the old format is in place, but is deprecated. + [Release Notes](./releases/8.0.md#8.0) for instructions on how to migrate to the new API. Some temporary support for + most of the old format is in place, but is deprecated. - **NEW**: SuperFences: has removed legacy code tab feature. Associated `legacy_tab_classes` option has been removed. Please use the Tabbed extension to create general purpose tabs for code blocks or other content. - **NEW**: Highlight: add new option `language_prefix` which controls the prefix applied to language classes when @@ -49,7 +49,7 @@ Please see [Release Notes](./release.md#upgrading-to-80) for details on upgradin ## 7.0 -Please see [Release Notes](./release.md#upgrading-to-70) for details on upgrading to 7.0. +Please see [Release Notes](./releases/7.0.md#7.0) for details on upgrading to 7.0. - **NEW**: MagicLink will now shorten user name and repository links when link shortening is enabled. - **NEW**: Added MagicLink options `social_url_shortener` and `shortener_user_exclude` were added. @@ -134,7 +134,7 @@ Please see [Release Notes](./release.md#upgrading-to-70) for details on upgradin ## 6.0 -Please see [Release Notes](./release.md) for details on upgrading to 6.0.0. +Please see [Release Notes](./releases/6.0.md#6.0) for details on upgrading to 6.0.0. - **NEW**: Allow custom inline highlight code blocks. (!380) - **NEW**: SuperFences now has one custom format convention which now also accepts the markdown class object to allow diff --git a/docs/src/markdown/about/release.md b/docs/src/markdown/about/release.md deleted file mode 100644 index d1e13d902..000000000 --- a/docs/src/markdown/about/release.md +++ /dev/null @@ -1,205 +0,0 @@ -# Release Notes - -## Upgrading to 8.0 - -One of the most invasive changes was adding the support of defining arbitrary attributes on code blocks in SuperFences -via the brace header format. This caused numerous changes that affects those define their own custom fences. It also - -### SuperFences Attribute List Support - -SuperFences has numerous changes so that users who wish not to use Pygments can set arbitrary attributes via the brace -header format so that can more extensively configure their code blocks for JavaScript syntax highlighters. This required -changes to how custom fences were handled. The changes mainly affect people using custom fences. In general, people not -defining their own custom fences will probably not notice any differences except they can now set attributes to code -blocks now. - -If users are still using the legacy tab feature of SuperFences, they will find that their tabs will no longer work. - -- Custom fence formatters are now expected to take a new keyword attribute called `attrs`. `attrs` contains a dictionary - of key/value pairs defining attributes that should be attached to the main block element generated by a given - formatter. In general, custom formatters *should* handle these, but at the very least, they should be updated to take - the argument even if they don't do anything with them. If your custom fence already accepts `**kwargs`, your fence - should continue to work, but to apply the attributes, you will have to read the `attrs` parameter from `kwargs`. - -- Custom fence validators have been updated to handle validation of inputs by assigning valid inputs to either an - `options` dictionary or an `attrs` dictionary. The new function signature looks like - `#!py3 validator(language, inputs, options, attrs, md):`. Inputs should never be modified. Options should have - inputs added to it that configure a formatter's features while `attrs` should have all other inputs. `attrs` will only - be passed to a formatter when Python Markdown's [`attr_list`][attr-list] extension is enabled. - - SuperFences will detect if you are using an older validator and should gracefully transition and use the old format, - but it is strongly recommended to use the new format. - -- Since attributes and options are now parsed via the [`attr_list`][attr-list] extension, custom fences can no longer - allow inputs in the form `key=`, they must be in the form `key`, `key="value"` or `key=value`. When defining an input - in the form `key` (with no value), the value will be the `key` name. To specify an empty `key`, please use `key=""`. - -- If a custom validator fails, SuperFences will now gracefully handle the error and try the next custom fence in the - queue. If a custom formatter fails, SuperFences will gracefully handle the error and abort processing the fence. If - you suspect your custom fence is not working, you should add your own debug code to your custom fence to verify - whether it is failing or not. - -- The tabbed feature of SuperFences has now been completely removed. Please use [Tabbed](../extensions/tabbed.md) - instead to create generic tabbed interfaces for code blocks and other content. - -### Highlight Changes - -Highlight added some new options to give users a little more control over code output format. Also some minor changes -were made as a result of it now able to have arbitrary attributes passed to it that are defined by a user via -SuperFences. - -- Previous versions of Highlight, when Pygments was disabled, would apply attributes to code blocks when options like - `linenums` were enabled. These attributes were often not helpful as they were generic and did not apply to all - JavaScript syntax highlighters. When Pygments is disabled, Highlight will no longer apply these unhelpful attributes - to code blocks, instead, if the user enables Python Markdown's `attr_list`, they can use SuperFences and define the - arbitrary attributes they need in the fenced code brace header, these attributes will be applied to the generated code - block. - - For instance, if a user needed to specify the line number start with an attribute `data-linenum-start`, they could - simply use the brace header format to define this new attribute: - - ```` - ```{.python data-linenum-start="30"} - import sys - ``` - ```` - -- Custom classes, IDs, and attributes are applied to the `code` element of generated code blocks, but if a JavaScript - highlighter requires classes, IDs, and attributes to be applied to the `pre` element instead of the `code` - element, the user can enable the new option in [Highlight](../extensions/highlight.md) called `code_attr_on_pre`. - -- By default, JavaScript ready code blocks would normally have the specified language class prefixed with `language-`. - This follows the HTML 5 specification, but some highlighters may prefer something different. The prefix can now be - changed with the new [Highlight](../extensions/highlight.md) option called `language_prefix`. - -### ExtraRawHTML Removed - -ExtraRawHTML has officially been removed. Please use Python Markdown's [`md_in_html`][md-in-html] extension instead. - -### SaneHeaders Added - -Same headers implements Markdown headers more like CommonMark. Headers require a space after the `#` symbol in order for -the line to be treated as a header. This allows you to use MagicLink issues at the start of a line. See -[SaneHeaders documentation](../extensions/saneheaders.md) for more information. - -## Upgrading to 7.0 - -### Tabbed Extension -A new extension called Tabbed has been added. With the arrival of this general purpose tabbed content extension, it has -made the old SuperFences tabbed content feature redundant. By default, SuperFences will now change the classes it uses -for it's tabbed feature to match those of the new Tabbed extension. CSS should be updated accordingly. - -The classes that have changed are `supferfences-tabs` and `superfences-content`, which have changed to `tabbed-set` and -`tabbed-content` respectively. Example CSS is updated in SuperFences for -[reference](../extensions/superfences.md). - -To help with the transition though, you can quickly switch back to the old style classes by simply enabling the -SuperFences' global option `legacy_tab_classes`: - -```py3 -extension_configs = { - "pymdownx.superfences": { - "legacy_tab_classes": True - } -} -``` - -To learn more about migrating to the Tabbed extension, checkout the [Tabbed documentation](../extensions/tabbed.md). - -SuperFences' tab content feature will be removed in 8.0. There is no formal date for when this will occur, but it is -recommended to begin migrating as soon as possible, but `legacy_tab_classes` can be used as a stop gap for the short -term. - -### Option Deprecation in SuperFences - -SuperFences has deprecated `highlight_code`. This option now does nothing and will be removed in some future release. -If this option was used, you will have to use [custom fences](../extensions/superfences.md#custom-fences) to implement -this behavior with your own custom formatter. - -### SuperFences Configurable Classes and IDs - -Additional classes and IDs can now be injected into fenced code blocks with the format ` ```{.lang .more-class} `. - -The attribute list feature also impacts the the custom formatter. While the default formatters will still inject -classes and IDs to the top level element to preserve backwards compatibility, the formatter now must accept the new -keyword parameters `classes` and `id_value`. If you have a custom formatter that does not adhere to this new -requirement, you will see a user warning. - -The new format is: - -```py3 -def custom_formatter(source, language, css_class, options, md, classes=None, id_value='', **kwargs): - return string -``` - -While it is recommended for a user to update their custom formatters to receive the new parameters, at the very -least, users should add `**kwargs` to future proof their formatters. - -### CodeHilite Separation - -SuperFences and InlineHilite no longer sync settings from CodeHilite. To configure either of the extensions, Pymdown -Extension's Highlight extension must be used. CodeHilite can be run along side Highlight if desired, but CodeHilite -cannot be used to augment SuperFences or InlineHilite's behavior. - -### Keys Alias Changes - -Previously `alt`, `left-alt`, and `right-alt` had aliases `menu`, `left-menu`, `right-menu`, `lmenu`, and `rmenu`. These -aliases have been removed. `menu` will now be an alias for `context-menu`. - -It is known that *Alt* has been referred to as *Menu* in the real world, but so is the actual *Menu*/*Apps* key. This -will hopefully create less confusion in the long term, even if there is a little in the short term. - -## Upgrading to 6.0 - -While there are a number of new features and bug fixes, the only backwards incompatible changes are with SuperFences' -custom fences. In an effort to make custom fences more useful, we wanted to be able to pass the `Markdown` object to the -formatters. This gives custom formats access to things like metadata if required. - -The format of custom fence formatters already had two different versions: ones without custom options and one with -custom options. As adding yet another parameter would cause more complexity behind the scenes, we decided to introduce -the breaking change of creating a unified format for formatters with custom options and without. In addition to unifying -the format, we also now pass the `Markdown` object to the formatters as an additional parameter. - -While we were breaking custom formats, it seemed like a good time to go ahead and change the defaults for the -`custom_fences` options. Most people who are using SuperFences aren't even using the default, niche `flow` and -`sequence` custom fences. Instead of hijacking fence names that most people aren't even using, it seemed more -appropriate to define no custom fences. - -Below are instructions on how to upgrade if you were relying on the either the default settings of `custom_fences` or if -you had written your own custom fence formatters. - -1. If you've written your own custom fence formatters, the number of parameters needed has changed, so you must update - your existing formatters. The needed parameters are the same regardless of whether you are using an options validator - or not. - - ```py3 - def custom_formatter(source, language, css_class, options, md): - return string - ``` - -2. `flow` and `sequence` are no longer defined by default. If you were relying on the default custom fences, you will - have to define them manually now. The needed settings are found below: - - ```py3 - extension_configs = { - "pymdownx.superfences": { - "custom_fences": [ - { - 'name': 'flow', - 'class': 'uml-flowchart', - 'format': pymdownx.superfences.fence_code_format - }, - { - 'name': 'sequence', - 'class': 'uml-sequence-diagram', - 'format': pymdownx.superfences.fence_code_format - } - ] - } - } - ``` - - If you are attempting to configure these options in a YAML based configuration (like in [MkDocs][mkdocs]), please - see the [FAQ](../faq.md#function-references-in-yaml) to see how to specify function references in YAML. - ---8<-- "refs.txt" diff --git a/docs/src/markdown/about/releases/6.0.md b/docs/src/markdown/about/releases/6.0.md new file mode 100644 index 000000000..f53e9e25e --- /dev/null +++ b/docs/src/markdown/about/releases/6.0.md @@ -0,0 +1,56 @@ +# 6.0 {: #\6.0} + +## Upgrade Notes + +While there are a number of new features and bug fixes, the only backwards incompatible changes are with SuperFences' +custom fences. In an effort to make custom fences more useful, we wanted to be able to pass the `Markdown` object to the +formatters. This gives custom formats access to things like metadata if required. + +The format of custom fence formatters already had two different versions: ones without custom options and one with +custom options. As adding yet another parameter would cause more complexity behind the scenes, we decided to introduce +the breaking change of creating a unified format for formatters with custom options and without. In addition to unifying +the format, we also now pass the `Markdown` object to the formatters as an additional parameter. + +While we were breaking custom formats, it seemed like a good time to go ahead and change the defaults for the +`custom_fences` options. Most people who are using SuperFences aren't even using the default, niche `flow` and +`sequence` custom fences. Instead of hijacking fence names that most people aren't even using, it seemed more +appropriate to define no custom fences. + +Below are instructions on how to upgrade if you were relying on the either the default settings of `custom_fences` or if +you had written your own custom fence formatters. + +1. If you've written your own custom fence formatters, the number of parameters needed has changed, so you must update + your existing formatters. The needed parameters are the same regardless of whether you are using an options validator + or not. + + ```py3 + def custom_formatter(source, language, css_class, options, md): + return string + ``` + +2. `flow` and `sequence` are no longer defined by default. If you were relying on the default custom fences, you will + have to define them manually now. The needed settings are found below: + + ```py3 + extension_configs = { + "pymdownx.superfences": { + "custom_fences": [ + { + 'name': 'flow', + 'class': 'uml-flowchart', + 'format': pymdownx.superfences.fence_code_format + }, + { + 'name': 'sequence', + 'class': 'uml-sequence-diagram', + 'format': pymdownx.superfences.fence_code_format + } + ] + } + } + ``` + + If you are attempting to configure these options in a YAML based configuration (like in [MkDocs][mkdocs]), please + see the [FAQ](../../faq.md#function-references-in-yaml) to see how to specify function references in YAML. + +--8<-- "refs.txt" diff --git a/docs/src/markdown/about/releases/7.0.md b/docs/src/markdown/about/releases/7.0.md new file mode 100644 index 000000000..2e94856e2 --- /dev/null +++ b/docs/src/markdown/about/releases/7.0.md @@ -0,0 +1,68 @@ +# 7.0 {: #\7.0} + +## Tabbed Extension +A new extension called Tabbed has been added. With the arrival of this general purpose tabbed content extension, it has +made the old SuperFences tabbed content feature redundant. By default, SuperFences will now change the classes it uses +for it's tabbed feature to match those of the new Tabbed extension. CSS should be updated accordingly. + +The classes that have changed are `supferfences-tabs` and `superfences-content`, which have changed to `tabbed-set` and +`tabbed-content` respectively. Example CSS is updated in SuperFences for +[reference](../../extensions/superfences.md). + +To help with the transition though, you can quickly switch back to the old style classes by simply enabling the +SuperFences' global option `legacy_tab_classes`: + +```py3 +extension_configs = { + "pymdownx.superfences": { + "legacy_tab_classes": True + } +} +``` + +To learn more about migrating to the Tabbed extension, checkout the [Tabbed documentation](../../extensions/tabbed.md). + +SuperFences' tab content feature will be removed in 8.0. There is no formal date for when this will occur, but it is +recommended to begin migrating as soon as possible, but `legacy_tab_classes` can be used as a stop gap for the short +term. + +## Option Deprecation in SuperFences + +SuperFences has deprecated `highlight_code`. This option now does nothing and will be removed in some future release. +If this option was used, you will have to use [custom fences](../../extensions/superfences.md#custom-fences) to +implement this behavior with your own custom formatter. + +## SuperFences Configurable Classes and IDs + +Additional classes and IDs can now be injected into fenced code blocks with the format ` ```{.lang .more-class} `. + +The attribute list feature also impacts the the custom formatter. While the default formatters will still inject +classes and IDs to the top level element to preserve backwards compatibility, the formatter now must accept the new +keyword parameters `classes` and `id_value`. If you have a custom formatter that does not adhere to this new +requirement, you will see a user warning. + +The new format is: + +```py3 +def custom_formatter(source, language, css_class, options, md, classes=None, id_value='', **kwargs): + return string +``` + +While it is recommended for a user to update their custom formatters to receive the new parameters, at the very +least, users should add `**kwargs` to future proof their formatters. + +## CodeHilite Separation + +SuperFences and InlineHilite no longer sync settings from CodeHilite. To configure either of the extensions, Pymdown +Extension's Highlight extension must be used. CodeHilite can be run along side Highlight if desired, but CodeHilite +cannot be used to augment SuperFences or InlineHilite's behavior. + +## Keys Alias Changes + +Previously `alt`, `left-alt`, and `right-alt` had aliases `menu`, `left-menu`, `right-menu`, `lmenu`, and `rmenu`. These +aliases have been removed. `menu` will now be an alias for `context-menu`. + +It is known that *Alt* has been referred to as *Menu* in the real world, but so is the actual *Menu*/*Apps* key. This +will hopefully create less confusion in the long term, even if there is a little in the short term. + +--8<-- "refs.txt" diff --git a/docs/src/markdown/about/releases/8.0.md b/docs/src/markdown/about/releases/8.0.md new file mode 100644 index 000000000..e03a30f63 --- /dev/null +++ b/docs/src/markdown/about/releases/8.0.md @@ -0,0 +1,110 @@ +# 8.0 {: #\8.0} + +## Overview + +In general, there are a couple things to be aware of when upgrading to 8.0. + +- Some previously deprecated features are now removed: tabbed code blocks via SuperFences and ExtraRawHTML. These were + originally deprecated as they are now redundant, and information is provided to allow you to get the same behavior + as before. + +- One of the most invasive changes was adding the support of defining arbitrary attributes on code blocks in SuperFences + via the brace header format. This caused numerous changes that affects those who define their own custom fences. If + you are only using the builtin fences provided by SuperFences, you will likely notice no adverse affects, but will be + able to take advantage of new the new features being offered. + +## Better Support for JS Highlighters + +- SuperFences adds the ability, when using the brace header format (` ```{.lang .class #id attr=value} `) to add + arbitrary HTML attributes to code blocks. By default, all classes, IDs and and attributes are added to the `code` + block of the generated output. The one exception is that the default `highlight` class is always added to the top + level element. + + For instance, if a user needed to specify that a line number starts with an attribute `data-linenum-start`, they + could simply use the brace header format to define this new attribute: + + ```` + ```{.python data-linenum-start="30"} + import sys + ``` + ```` + + Attributes will only be used when Python Markdown's [`attr_list`][attr-list] extension is enabled. Attributes will + also be ignored when using Pygments as Pygments doesn't directly support adding IDs or arbitrary attributes. + + This allows for more extensive configuration when using JavaScript highlighters. Now users can set the appropriate + attributes to configure line numbers and other highlighter specific features without the Highlight extension getting + in the way. + +- Some JS highlighters may require attributes and classes to be assigned to the `pre` element, so the + [Highlight](../../extensions/highlight.md) extension has added a new feature called `code_attr_on_pre`. This new + option will ensure that custom classes, IDs, and attributes are applied to the `pre` element instead. + +- By default, JavaScript ready code blocks would normally have the specified language class prefixed with `language-`. + This follows the HTML 5 specification, but some highlighters may prefer something different. The prefix can now be + changed with the new [Highlight](../../extensions/highlight.md) option called `language_prefix`. + +## Retired Features + +- The legacy tab feature has been removed from SuperFences. This does not mean tab support is dead as the + [Tabbed](../../extensions/tabbed.md) extension actually provides an even more useful, general purpose, solution. It + was impossible to keep this legacy feature around, in its current implementation, after the restructure of for + attribute list support, so we decided to officially retire this already deprecated feature. + +- ExtraRawHTML has officially been removed. This extension only existed because Python Markdown did not have the feature + exposed in a manner that allowed you to use it without including all of their "Extra" extension, now that Python + Markdown has exposed this extension by itself, there is no longer a reason for us expose it via ExtraRawHTML. Please + use Python Markdown's [`md_in_html`][md-in-html] extension instead to get the same exact functionality. + +## Custom Fence Changes + +SuperFences made numerous changes so that users who wish not to use Pygments can set arbitrary attributes via the brace +header format so that can more extensively configure their code blocks for JavaScript syntax highlighters. This required +changes to how custom fences were handled. + +- Custom fence formatters are now expected to take a new keyword attribute called `attrs`. `attrs` contains a dictionary + of key/value pairs defining attributes that should be attached to the main block element generated by a given + formatter. In general, custom formatters *should* handle these, but are not required to. At the very least, they + should be updated to take the argument even if they don't do anything with them. Custom fences that do not accept this + parameter will silently fail. If your custom fence already accepts `**kwargs` (as recommended in the 7.0 release), + your fence should continue to work even you do not do anything with the attributes. No use and apply the new, + attributes, you will have to read the `attrs` parameter and set those to one of the elements in your generated HTML. + +- Custom fence validators have been updated to handle validation of inputs by assigning valid inputs to either an + `options` dictionary or an `attrs` dictionary. The new function signature looks like this: + `#!py3 validator(language, inputs, options, attrs, md):`. + + - `inputs` contains all the parsed key/value pairs and should **never** be modified. `options` should have inputs + added to it that configure a formatter's features. You should parse, format and assign all inputs that are + considered options to the `option` dictionary. + + - `attrs` normally would contain copies of any non-option key/value pairs from inputs, unaltered. These would usually + be applied to HTML elements as attributes. + + - `md` is the `Markdown` class instance and is useful if you want to access meta data or anything else in your + validator. + + SuperFences will detect if you are using an older validator and should gracefully transition and use the old format, + but it is strongly recommended to use the new format. If you run into any issues, you are required to update to the + new format. In a future version, the graceful transition will be removed. + +- Since attributes and options are now parsed via the [`attr_list`][attr-list] extension, custom fences can no longer + allow inputs in the form `key=` (with no value), they must be in the form `key`, `key="value"` or `key=value`. When + defining an input in the form `key` (with no value), the value will be the `key` name (this is how + [`attr_list`][attr-list] handles such cases). To specify an empty `key`, please use `key=""`. + +- If a custom validator fails, SuperFences will now gracefully handle the error and try the next custom fence in the + queue. If a custom formatter fails. If you suspect your custom validator is not working, you should add your own debug + code to your custom fence to verify whether it is failing or not. + +- SuperFences will gracefully handle the error and abort processing the fence. If you suspect your custom formatter is + not working, you should add your own debug code to your custom fence to verify whether it is failing or not. + +## New Extension + +[SaneHeaders](../../extensions/saneheaders.md) implements Markdown headers more like CommonMark. Headers require a space +after the `#` symbol in order for the line to be treated as a header. This allows you to use +[MagicLink](../../extensions/magiclink.md) issues at the start of a line. See +[SaneHeaders documentation](../../extensions/saneheaders.md) for more information. + +--8<-- "refs.txt" diff --git a/docs/src/mkdocs.yml b/docs/src/mkdocs.yml index 34aa56357..63ac3353b 100644 --- a/docs/src/mkdocs.yml +++ b/docs/src/mkdocs.yml @@ -57,7 +57,10 @@ nav: - Contributing & Support: about/contributing.md - Development: about/development.md - Changelog: about/changelog.md - - Release Notes: about/release.md + - Release Notes: + - '6.0': about/releases/6.0.md + - '7.0': about/releases/7.0.md + - '8.0': about/releases/8.0.md - License: about/license.md markdown_extensions: diff --git a/docs/theme/announce.html b/docs/theme/announce.html index aa99ce887..cd991cfd3 100644 --- a/docs/theme/announce.html +++ b/docs/theme/announce.html @@ -1,6 +1,6 @@ - 8.0 has been released! Check out the Release Notes for more information and migration tips. + 8.0 has been released! Check out the Release Notes for more information and migration tips.
Sponsorship is now available! diff --git a/mkdocs.yml b/mkdocs.yml index e134c4f57..e836207f2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,10 @@ nav: - Contributing & Support: about/contributing.md - Development: about/development.md - Changelog: about/changelog.md - - Release Notes: about/release.md + - Release Notes: + - '6.0': about/releases/6.0.md + - '7.0': about/releases/7.0.md + - '8.0': about/releases/8.0.md - License: about/license.md markdown_extensions: diff --git a/pymdownx/__meta__.py b/pymdownx/__meta__.py index 814cf83f8..5add38705 100644 --- a/pymdownx/__meta__.py +++ b/pymdownx/__meta__.py @@ -185,5 +185,5 @@ def parse_version(ver, pre=False): return Version(major, minor, micro, release, pre, post, dev) -__version_info__ = Version(8, 0, 0, ".dev") +__version_info__ = Version(8, 0, 0, "final") __version__ = __version_info__._get_canonical()