mkdocs-alias-plugin 0.8.1__tar.gz → 0.8.2__tar.gz

{mkdocs-alias-plugin-0.8.1/mkdocs_alias_plugin.egg-info → mkdocs_alias_plugin-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: mkdocs-alias-plugin
-Version: 0.8.1
+Version: 0.8.2
 Summary: An MkDocs plugin allowing links to your pages using a custom alias
 Home-page: https://github.com/eddyluten/mkdocs-alias-plugin
 Author: Eddy Luten
@@ -20,10 +20,21 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: mkdocs
 Requires-Dist: markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # mkdocs-alias-plugin
 
-[![PyPI version](https://badge.fury.io/py/mkdocs-alias-plugin.svg)](https://pypi.org/project/mkdocs-alias-plugin/)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![example workflow](https://github.com/eddyluten/mkdocs-alias-plugin/actions/workflows/pylint.yml/badge.svg) [![Downloads](https://pepy.tech/badge/mkdocs-alias-plugin)](https://pepy.tech/project/mkdocs-alias-plugin) ![](https://github.com/eddyluten/mkdocs-alias-plugin/workflows/mkdocs-alias-plugin%20Tests/badge.svg)
+[![PyPI version](https://badge.fury.io/py/mkdocs-alias-plugin.svg)](https://pypi.org/project/mkdocs-alias-plugin/)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Downloads](https://pepy.tech/badge/mkdocs-alias-plugin)](https://pepy.tech/project/mkdocs-alias-plugin) [![CI](https://github.com/eddyluten/mkdocs-alias-plugin/workflows/mkdocs-alias-plugin%20CI/badge.svg)](https://github.com/EddyLuten/mkdocs-alias-plugin/actions/workflows/ci.yml)
 
 The `mkdocs-alias-plugin` MkDocs plugin allows links to your pages using a custom alias such as `[[my-alias]]` or `[[my-alias|My Title]]`.
 
@@ -100,6 +111,8 @@ The song references [[wuthering-heights#references|Wuthering Heights]].
 
 As of version 0.8.0, you can enable the plugin option `use_anchor_titles` to replace anchor links with the text of the page heading that defined it. This behavior is opt-in to preserve backward compatibility.
 
+As of version 0.9.0, you may also use `aliases` in addition to (or in place of) the `alias` key in the meta section of your pages. This is to provide some similarity to other Markdown based software that supports aliases, such as Obsidian.
+
 Please refer to the [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data) for more information on how the meta-data block is used.
 
 ### Multiple Aliases
@@ -134,16 +147,23 @@ plugins:
     - alias:
         verbose: true
         use_anchor_titles: true
+        use_page_icon: true
 ```
 
 ### `verbose`
 
-You may use the optional `verbose` option to print more information about which aliases were used and defined during the build process. The default value is `false`.
+You may use the optional `verbose` option to print more information about which aliases were used and defined during the build process. A tab-delimited file named `aliases.log` will also be defined at the project root, containing a list of every alias defined by the wiki.
+
+The default value is `false` and should only be enabled when debugging issue with the plugin.
 
 ### `use_anchor_titles`
 
 Setting this flag to true causes the plugin to replace an alias containing an anchor (`[[my-page#sub-heading]]`) with the text of the header that defined it. You can still override the title of the link as usual.
 
+### `use_page_icons`
+
+Setting this flag to true will include the [page's icon](https://squidfunk.github.io/mkdocs-material/reference/?h=page+icon#setting-the-page-icon) in the alias substitution if it's set for a given page.
+
 ## Troubleshooting
 
 ### The link text looks like a path or URL
@@ -168,6 +188,13 @@ Aliases *must* be unique. Ensure that you're not redefining the same alias for a
 
 ## Local Development
 
+Upgrade pip and install the dependencies:
+
+```zsh
+python -m pip install --upgrade pip
+pip install mkdocs pytest pylint markdown setuptools
+```
+
 Installing a local copy of the plugin:
 
 ```zsh
@@ -188,16 +215,33 @@ pylint $(git ls-files '*.py') && pytest -vv
 
 ## Changelog
 
+## 0.9.0
+
+2025-02-21
+
+**Features and Bug Fixes:**
+
+- Added the ability to use alias style links to anchors withing the current page, e.g.: `[[#my-anchor]]`.
+- Added support for page icons in link aliases, thank you @joapuiib for your [contribution](https://github.com/EddyLuten/mkdocs-alias-plugin/pull/15)!
+- Added support for using the key `alias` and/or `aliases` for defining page aliases in meta sections.
+- Changed verbose mode to now also generates a tab-delimited log file containing each alias in the wiki.
+
 ## 0.8.1
 
+2024-04-08
+
 **Bug Fix:** fixes a bug where annotations would break older versions of Python 3. Bug report: [#9](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/9).
 
 ## 0.8.0
 
+2024-04-06
+
 This release adds functionality to replace the titles of aliases containing anchors with the text of the heading that defines them. Enable this feature by setting the plugin option `use_anchor_titles` to true. Feature request: [#8](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/8).
 
 ### 0.7.1
 
+2024-04-07
+
 **Bug Fix:** fixes a bug where any alias with the word "text" would break the plugin due to faulty logic. Bug report: [#7](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/7).
 
 ### 0.7.0

mkdocs-alias-plugin-0.8.1/PKG-INFO → mkdocs_alias_plugin-0.8.2/README.md

@@ -1,29 +1,6 @@
-Metadata-Version: 2.1
-Name: mkdocs-alias-plugin
-Version: 0.8.1
-Summary: An MkDocs plugin allowing links to your pages using a custom alias
-Home-page: https://github.com/eddyluten/mkdocs-alias-plugin
-Author: Eddy Luten
-Author-email: eddyluten@gmail.com
-License: MIT
-Keywords: mkdocs python markdown alias link wiki
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Documentation
-Classifier: Topic :: Text Processing
-Classifier: Topic :: Text Processing :: Markup
-Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.0
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
-Requires-Dist: mkdocs
-Requires-Dist: markdown
-
 # mkdocs-alias-plugin
 
-[![PyPI version](https://badge.fury.io/py/mkdocs-alias-plugin.svg)](https://pypi.org/project/mkdocs-alias-plugin/)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![example workflow](https://github.com/eddyluten/mkdocs-alias-plugin/actions/workflows/pylint.yml/badge.svg) [![Downloads](https://pepy.tech/badge/mkdocs-alias-plugin)](https://pepy.tech/project/mkdocs-alias-plugin) ![](https://github.com/eddyluten/mkdocs-alias-plugin/workflows/mkdocs-alias-plugin%20Tests/badge.svg)
+[![PyPI version](https://badge.fury.io/py/mkdocs-alias-plugin.svg)](https://pypi.org/project/mkdocs-alias-plugin/)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Downloads](https://pepy.tech/badge/mkdocs-alias-plugin)](https://pepy.tech/project/mkdocs-alias-plugin) [![CI](https://github.com/eddyluten/mkdocs-alias-plugin/workflows/mkdocs-alias-plugin%20CI/badge.svg)](https://github.com/EddyLuten/mkdocs-alias-plugin/actions/workflows/ci.yml)
 
 The `mkdocs-alias-plugin` MkDocs plugin allows links to your pages using a custom alias such as `[[my-alias]]` or `[[my-alias|My Title]]`.
 
@@ -100,6 +77,8 @@ The song references [[wuthering-heights#references|Wuthering Heights]].
 
 As of version 0.8.0, you can enable the plugin option `use_anchor_titles` to replace anchor links with the text of the page heading that defined it. This behavior is opt-in to preserve backward compatibility.
 
+As of version 0.9.0, you may also use `aliases` in addition to (or in place of) the `alias` key in the meta section of your pages. This is to provide some similarity to other Markdown based software that supports aliases, such as Obsidian.
+
 Please refer to the [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data) for more information on how the meta-data block is used.
 
 ### Multiple Aliases
@@ -134,16 +113,23 @@ plugins:
     - alias:
         verbose: true
         use_anchor_titles: true
+        use_page_icon: true
 ```
 
 ### `verbose`
 
-You may use the optional `verbose` option to print more information about which aliases were used and defined during the build process. The default value is `false`.
+You may use the optional `verbose` option to print more information about which aliases were used and defined during the build process. A tab-delimited file named `aliases.log` will also be defined at the project root, containing a list of every alias defined by the wiki.
+
+The default value is `false` and should only be enabled when debugging issue with the plugin.
 
 ### `use_anchor_titles`
 
 Setting this flag to true causes the plugin to replace an alias containing an anchor (`[[my-page#sub-heading]]`) with the text of the header that defined it. You can still override the title of the link as usual.
 
+### `use_page_icons`
+
+Setting this flag to true will include the [page's icon](https://squidfunk.github.io/mkdocs-material/reference/?h=page+icon#setting-the-page-icon) in the alias substitution if it's set for a given page.
+
 ## Troubleshooting
 
 ### The link text looks like a path or URL
@@ -168,6 +154,13 @@ Aliases *must* be unique. Ensure that you're not redefining the same alias for a
 
 ## Local Development
 
+Upgrade pip and install the dependencies:
+
+```zsh
+python -m pip install --upgrade pip
+pip install mkdocs pytest pylint markdown setuptools
+```
+
 Installing a local copy of the plugin:
 
 ```zsh
@@ -188,16 +181,33 @@ pylint $(git ls-files '*.py') && pytest -vv
 
 ## Changelog
 
+## 0.9.0
+
+2025-02-21
+
+**Features and Bug Fixes:**
+
+- Added the ability to use alias style links to anchors withing the current page, e.g.: `[[#my-anchor]]`.
+- Added support for page icons in link aliases, thank you @joapuiib for your [contribution](https://github.com/EddyLuten/mkdocs-alias-plugin/pull/15)!
+- Added support for using the key `alias` and/or `aliases` for defining page aliases in meta sections.
+- Changed verbose mode to now also generates a tab-delimited log file containing each alias in the wiki.
+
 ## 0.8.1
 
+2024-04-08
+
 **Bug Fix:** fixes a bug where annotations would break older versions of Python 3. Bug report: [#9](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/9).
 
 ## 0.8.0
 
+2024-04-06
+
 This release adds functionality to replace the titles of aliases containing anchors with the text of the heading that defines them. Enable this feature by setting the plugin option `use_anchor_titles` to true. Feature request: [#8](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/8).
 
 ### 0.7.1
 
+2024-04-07
+
 **Bug Fix:** fixes a bug where any alias with the word "text" would break the plugin due to faulty logic. Bug report: [#7](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/7).
 
 ### 0.7.0

{mkdocs-alias-plugin-0.8.1 → mkdocs_alias_plugin-0.8.2}/alias/plugin.py

@@ -50,21 +50,24 @@ def find_anchor_by_id(anchors: list[MarkdownAnchor], anchor_id: str) -> Markdown
     return None
 
 
-def get_page_title(page_src: str, meta_data: dict):
+def get_page_title(page_src: str, meta_data: dict, include_icon: bool = False):
     """Returns the title of the page. The title in the meta data section
     will take precedence over the H1 markdown title if both are provided."""
-    return (
-        meta_data['title']
-        if 'title' in meta_data and isinstance(meta_data['title'], str)
-        else get_markdown_title(page_src)
-    )
+    if 'title' in meta_data and isinstance(meta_data['title'], str):
+        title = meta_data['title']
+        if include_icon and 'icon' in meta_data and isinstance(meta_data['icon'], str):
+            icon = ':' + meta_data['icon'].replace('/', '-') + ':'
+            title = f'{icon} {title}'
+    else:
+        title = get_markdown_title(page_src)
+    return title
 
 
-def get_alias_names(meta_data: dict):
+def get_alias_names(meta_data: dict, meta_key: str = 'alias') -> list[str] | None:
     """Returns the list of configured alias names."""
-    if len(meta_data) <= 0 or 'alias' not in meta_data:
+    if len(meta_data) <= 0 or meta_key not in meta_data:
         return None
-    aliases = meta_data['alias']
+    aliases = meta_data[meta_key]
     if isinstance(aliases, list):
         # If the alias meta data is a list, ensure that they're strings
         return list(filter(lambda value: isinstance(value, str), aliases))
@@ -91,13 +94,27 @@ def replace_tag(
     if match.group(2) is not None:
         tag_bits = str(match.group(2)).split('#')
     alias = aliases.get(tag_bits[0])
+
+    # if the alias is not found, log a warning and return the input string
+    # unless the alias is an anchor tag, then try to find the anchor tag
+    # and replace it with the anchor's title
     if alias is None:
-        log.warning(
-            "Alias '%s' not found in '%s'",
-            match.group(2),
-            page_file.src_path
-        )
-        return match.group(0)  # return the input string
+        if len(tag_bits) < 2:
+            log.warning(
+                "Alias '%s' not found in '%s'",
+                match.group(2),
+                page_file.src_path
+            )
+            return match.group(0) # return the input string
+        anchor = tag_bits[1]
+        matched = match.group(2)
+        # using the [[#anchor]] syntax to link within the current page:
+        if str(matched).startswith('#'):
+            anchors = get_markdown_toc(page_file.content_string)
+            anchor_tag = find_anchor_by_id(anchors, anchor)
+            if anchor_tag is not None:
+                log.info(f"treating {matched} like an anchor to {anchor_tag['name']}")
+                return f"[{anchor_tag['name']}](#{anchor})"
 
     text = None
     anchor = tag_bits[1] if len(tag_bits) > 1 else None
@@ -140,6 +157,7 @@ class AliasPlugin(BasePlugin):
     config_scheme = (
         ('verbose', config_options.Type(bool, default=False)),
         ('use_anchor_titles', config_options.Type(bool, default=False)),
+        ('use_page_icon', config_options.Type(bool, default=False)),
     )
     aliases = {}
     log = logging.getLogger(f'mkdocs.plugins.{__name__}')
@@ -158,7 +176,7 @@ class AliasPlugin(BasePlugin):
         self.log.info("Defined %s alias(es).", len(self.aliases))
         self.aliases.clear()
 
-    def on_page_markdown(self, markdown: str, *, page: Page, **_):
+    def on_page_markdown(self, markdown: str, /, *, page: Page, **_):
         """Replaces any alias tags on the page with markdown links."""
         self.current_page = page
         return re.sub(
@@ -173,52 +191,68 @@ class AliasPlugin(BasePlugin):
             markdown
         )
 
-    def on_files(self, files: Files, **_):
+    def on_files(self, files: Files, /, **_):
         """When MkDocs loads its files, extract aliases from any Markdown files
         that were found.
         """
         for file in filter(lambda f: f.is_documentation_page(), files):
             with open(file.abs_src_path, encoding='utf-8-sig', errors='strict') as handle:
-                source, meta_data = meta.get_data(handle.read())
-                alias_names = get_alias_names(meta_data)
-                if alias_names is None or len(alias_names) < 1:
-                    continue
+                self.process_file(file, handle)
+        # write the aliases to the aliases log file if the verbose option is set
+        if self.config['verbose']:
+            with open('aliases.log', 'w', encoding='utf-8') as log_file:
+                log_file.write("alias\ttitle\turl\n")
+                for alias in self.aliases.values():
+                    log_file.write(
+                        f"{alias['alias']}\t{alias['text']}\t{alias['url']}\n"
+                    )
 
-                # If the use_anchor_titles config option is set, parse the markdown
-                # and get the table of contents for the page
-                anchors: list[MarkdownAnchor] = []
-                if self.config['use_anchor_titles']:
-                    anchors = get_markdown_toc(source)
+    def process_file(self, file, handle):
+        """Extract aliases from the given file and add them to the aliases"""
+        source, meta_data = meta.get_data(handle.read())
+        for section in ['alias', 'aliases']:
+            alias_names = get_alias_names(meta_data, section)
+            if alias_names is None or len(alias_names) < 1:
+                continue
 
-                if len(alias_names) > 1:
-                    self.log.info(
-                        '%s defines %d aliases:', file.url, len(alias_names)
-                    )
-                for alias in alias_names:
-                    existing = self.aliases.get(alias)
-                    if existing is not None:
-                        self.log.warning(
-                            "%s: alias %s already defined in %s, skipping.",
-                            file.src_uri,
-                            alias,
-                            existing['url']
-                        )
-                        continue
-
-                    new_alias = {
-                        'alias': alias,
-                        'text': (
-                            meta_data['alias']['text']
-                            # if meta_data['alias'] is a dictionary and 'text' is a key
-                            if isinstance(meta_data['alias'], dict) and 'text' in meta_data['alias']
-                            else get_page_title(source, meta_data)
-                        ),
-                        'url': file.src_uri,
-                        'anchors': anchors,
-                    }
-                    self.log.info(
-                        "Alias %s to %s",
+            # If the use_anchor_titles config option is set, parse the markdown
+            # and get the table of contents for the page
+            anchors: list[MarkdownAnchor] = []
+            if self.config['use_anchor_titles']:
+                anchors = get_markdown_toc(source)
+
+            if len(alias_names) > 1:
+                self.log.info(
+                    '%s defines %d aliases:', file.url, len(alias_names)
+                )
+            for alias in alias_names:
+                existing = self.aliases.get(alias)
+                if existing is not None:
+                    self.log.warning(
+                        "%s: alias %s already defined in %s, skipping.",
+                        file.src_uri,
                         alias,
-                        new_alias['url']
+                        existing['url']
                     )
-                    self.aliases[alias] = new_alias
+                    continue
+
+                new_alias = {
+                    'alias': alias,
+                    'text': (
+                        meta_data[section]['text']
+                        # if meta_data['alias'] is a dictionary and 'text' is a key
+                        if (
+                            isinstance(meta_data[section], dict) and
+                            'text' in meta_data[section]
+                        )
+                        else get_page_title(source, meta_data, self.config['use_page_icon'])
+                    ),
+                    'url': file.src_uri,
+                    'anchors': anchors,
+                }
+                self.log.info(
+                    "Alias %s to %s",
+                    alias,
+                    new_alias['url']
+                )
+                self.aliases[alias] = new_alias

mkdocs-alias-plugin-0.8.1/README.md → mkdocs_alias_plugin-0.8.2/mkdocs_alias_plugin.egg-info/PKG-INFO

@@ -1,6 +1,40 @@
+Metadata-Version: 2.2
+Name: mkdocs-alias-plugin
+Version: 0.8.2
+Summary: An MkDocs plugin allowing links to your pages using a custom alias
+Home-page: https://github.com/eddyluten/mkdocs-alias-plugin
+Author: Eddy Luten
+Author-email: eddyluten@gmail.com
+License: MIT
+Keywords: mkdocs python markdown alias link wiki
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: mkdocs
+Requires-Dist: markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
 # mkdocs-alias-plugin
 
-[![PyPI version](https://badge.fury.io/py/mkdocs-alias-plugin.svg)](https://pypi.org/project/mkdocs-alias-plugin/)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![example workflow](https://github.com/eddyluten/mkdocs-alias-plugin/actions/workflows/pylint.yml/badge.svg) [![Downloads](https://pepy.tech/badge/mkdocs-alias-plugin)](https://pepy.tech/project/mkdocs-alias-plugin) ![](https://github.com/eddyluten/mkdocs-alias-plugin/workflows/mkdocs-alias-plugin%20Tests/badge.svg)
+[![PyPI version](https://badge.fury.io/py/mkdocs-alias-plugin.svg)](https://pypi.org/project/mkdocs-alias-plugin/)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Downloads](https://pepy.tech/badge/mkdocs-alias-plugin)](https://pepy.tech/project/mkdocs-alias-plugin) [![CI](https://github.com/eddyluten/mkdocs-alias-plugin/workflows/mkdocs-alias-plugin%20CI/badge.svg)](https://github.com/EddyLuten/mkdocs-alias-plugin/actions/workflows/ci.yml)
 
 The `mkdocs-alias-plugin` MkDocs plugin allows links to your pages using a custom alias such as `[[my-alias]]` or `[[my-alias|My Title]]`.
 
@@ -77,6 +111,8 @@ The song references [[wuthering-heights#references|Wuthering Heights]].
 
 As of version 0.8.0, you can enable the plugin option `use_anchor_titles` to replace anchor links with the text of the page heading that defined it. This behavior is opt-in to preserve backward compatibility.
 
+As of version 0.9.0, you may also use `aliases` in addition to (or in place of) the `alias` key in the meta section of your pages. This is to provide some similarity to other Markdown based software that supports aliases, such as Obsidian.
+
 Please refer to the [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data) for more information on how the meta-data block is used.
 
 ### Multiple Aliases
@@ -111,16 +147,23 @@ plugins:
     - alias:
         verbose: true
         use_anchor_titles: true
+        use_page_icon: true
 ```
 
 ### `verbose`
 
-You may use the optional `verbose` option to print more information about which aliases were used and defined during the build process. The default value is `false`.
+You may use the optional `verbose` option to print more information about which aliases were used and defined during the build process. A tab-delimited file named `aliases.log` will also be defined at the project root, containing a list of every alias defined by the wiki.
+
+The default value is `false` and should only be enabled when debugging issue with the plugin.
 
 ### `use_anchor_titles`
 
 Setting this flag to true causes the plugin to replace an alias containing an anchor (`[[my-page#sub-heading]]`) with the text of the header that defined it. You can still override the title of the link as usual.
 
+### `use_page_icons`
+
+Setting this flag to true will include the [page's icon](https://squidfunk.github.io/mkdocs-material/reference/?h=page+icon#setting-the-page-icon) in the alias substitution if it's set for a given page.
+
 ## Troubleshooting
 
 ### The link text looks like a path or URL
@@ -145,6 +188,13 @@ Aliases *must* be unique. Ensure that you're not redefining the same alias for a
 
 ## Local Development
 
+Upgrade pip and install the dependencies:
+
+```zsh
+python -m pip install --upgrade pip
+pip install mkdocs pytest pylint markdown setuptools
+```
+
 Installing a local copy of the plugin:
 
 ```zsh
@@ -165,16 +215,33 @@ pylint $(git ls-files '*.py') && pytest -vv
 
 ## Changelog
 
+## 0.9.0
+
+2025-02-21
+
+**Features and Bug Fixes:**
+
+- Added the ability to use alias style links to anchors withing the current page, e.g.: `[[#my-anchor]]`.
+- Added support for page icons in link aliases, thank you @joapuiib for your [contribution](https://github.com/EddyLuten/mkdocs-alias-plugin/pull/15)!
+- Added support for using the key `alias` and/or `aliases` for defining page aliases in meta sections.
+- Changed verbose mode to now also generates a tab-delimited log file containing each alias in the wiki.
+
 ## 0.8.1
 
+2024-04-08
+
 **Bug Fix:** fixes a bug where annotations would break older versions of Python 3. Bug report: [#9](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/9).
 
 ## 0.8.0
 
+2024-04-06
+
 This release adds functionality to replace the titles of aliases containing anchors with the text of the heading that defines them. Enable this feature by setting the plugin option `use_anchor_titles` to true. Feature request: [#8](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/8).
 
 ### 0.7.1
 
+2024-04-07
+
 **Bug Fix:** fixes a bug where any alias with the word "text" would break the plugin due to faulty logic. Bug report: [#7](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/7).
 
 ### 0.7.0

{mkdocs-alias-plugin-0.8.1 → mkdocs_alias_plugin-0.8.2}/setup.py

@@ -7,7 +7,7 @@ long_description = (this_directory / 'README.md').read_text()
 
 setup(
     name='mkdocs-alias-plugin',
-    version='0.8.1',
+    version='0.8.2',
     description=
     'An MkDocs plugin allowing links to your pages using a custom alias',
     long_description=long_description,