prcr / mkdocs-meta-descriptions-plugin Goto Github PK

Go through the breaking changes from the MkDocs 1.5.0 changelog and make any necessary changes to the code to ensure that it is compatible with MkDocs 1.5.0.

In particular, some WARNING log messages are now being output with the DEBUG log level instead.

Cc: @autopilot

I suggest using the max variable to trim meta descriptions that have more characters than the value of the variable

Review the MkDocs 1.4.0 changelog and reflect any relevant changes on the plugin:

https://github.com/mkdocs/mkdocs/releases/tag/1.4.0

Go through the breaking changes from the MkDocs 1.4.0 changelog and make any necessary changes to the code to ensure that it is compatible with MkDocs 1.4.0.

Supersedes #193.

There are some situations where the text of the first paragraph that is found by the plugin may be empty.

For example:

<p><a href="...">Welcome to the site!</a></p>

<p><img src="..."/></p>

Perhaps in situations like this the plugin could try to find a sibling paragraph that does include text.

Solve the deprecation warning for collections.abc:

$ mkdocs build
INFO     -  DeprecationWarning: Using or importing the ABCs from 'collections' instead of from
            'collections.abc' is deprecated since Python 3.3, and in 3.10 it will stop working
              File "/usr/lib/python3/dist-packages/html5lib/_trie/_base.py", line 3, in <module>
                from collections import Mapping
              File "/usr/lib/python3.8/collections/__init__.py", line 49, in __getattr__
                warnings.warn("Using or importing the ABCs from 'collections' instead "
INFO     -  Cleaning site directory

Hi,
I get this error when trying to use the plugin with Material for MkDocs. What am I doing wrong?

If site_url is defined, use it to build the page URLs before writing them to the meta-descriptions.csv file.

Trim the text of the first paragraph found, and check the length of the text only after trimming.

If the first paragraph of a page includes double quotes, the plugin should remove or escape them so that they don't break the description attribute of the <meta> HTML element.

Describe the bug
A clear and concise description of what the bug is.

The plugin incorrectly considers the paragraph that contains the title of the admonition as the meta description for a page:

<h1 id="title">Title</h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Note text</p>
</div>
<p>This should be used as the meta description</p>

To Reproduce
The list of steps to reproduce the behavior.

Expected behavior
A clear and concise description of what you expected to happen.

The plugin should only consider for the meta description paragraphs that are siblings to the <h1> tag. Decide if in these cases the <div> can be ignored and the next <p> is used, or if no meta description should be deduced from the page content.

Additional context
Add any other context about the problem here.

I identified the issue on this page.