mkdocs-document-dates 3.4.5__tar.gz → 3.4.7__tar.gz

{mkdocs_document_dates-3.4.5/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.5
+Version: 3.4.7
 Summary: A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -37,13 +37,14 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 ## Features
 
 - [x] Always displays **exact** meta information of the document and works in any environment (no Git, Git environments, Docker containers, all CI/CD build systems, etc.)
+- [x] Support list display of recently updated documents (in descending order of update time)
 - [x] Support for manually specifying time and author in `Front Matter`
 - [x] Support for multiple time formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
+- [x] Support for manually configuring author's name, link, avatar, email, etc.
 - [x] Flexible display position (top or bottom)
 - [x] Elegant styling (fully customizable)
 - [x] Smart Tooltip Hover Tips
-- [x] Support list display of recently updated documents
 - [x] Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
 - [x] Cross-platform support (Windows, macOS, Linux)
 - [x] **Ultimate build efficiency**: O(1), no need to set env vars to distinguish runs
@@ -81,7 +82,6 @@ plugins:
       date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
       show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
-      recently-updated: true   # Whether to turn on recently updated data, default: false
 ```
 
 ## Customization Settings
@@ -89,12 +89,12 @@ plugins:
 In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:
 
 - [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): You can manually specify the creation time and last update time for each document
-- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document
+- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document, such as name, link, avatar, email, etc.
 - [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author
 - [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): Such as icons, themes, colors, fonts, animations, dividing line, etc.
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [Use Template Variables](https://jaywhj.netlify.app/document-dates-en#Use-Template-Variables): Can be used to optimize `sitemap.xml` for site SEO, can be used to re-customize plug-ins, etc.
-- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents
+- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update time)
 - [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it in Docker
 - [Development Stories](https://jaywhj.netlify.app/document-dates-en#Development-Stories): Describes the origin of the plug-in, the difficulties and solutions encountered in development, and the principles and directions of product design
 

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7}/README.md

@@ -11,13 +11,14 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 ## Features
 
 - [x] Always displays **exact** meta information of the document and works in any environment (no Git, Git environments, Docker containers, all CI/CD build systems, etc.)
+- [x] Support list display of recently updated documents (in descending order of update time)
 - [x] Support for manually specifying time and author in `Front Matter`
 - [x] Support for multiple time formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
+- [x] Support for manually configuring author's name, link, avatar, email, etc.
 - [x] Flexible display position (top or bottom)
 - [x] Elegant styling (fully customizable)
 - [x] Smart Tooltip Hover Tips
-- [x] Support list display of recently updated documents
 - [x] Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
 - [x] Cross-platform support (Windows, macOS, Linux)
 - [x] **Ultimate build efficiency**: O(1), no need to set env vars to distinguish runs
@@ -55,7 +56,6 @@ plugins:
       date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
       show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
-      recently-updated: true   # Whether to turn on recently updated data, default: false
 ```
 
 ## Customization Settings
@@ -63,12 +63,12 @@ plugins:
 In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:
 
 - [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): You can manually specify the creation time and last update time for each document
-- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document
+- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document, such as name, link, avatar, email, etc.
 - [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author
 - [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): Such as icons, themes, colors, fonts, animations, dividing line, etc.
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [Use Template Variables](https://jaywhj.netlify.app/document-dates-en#Use-Template-Variables): Can be used to optimize `sitemap.xml` for site SEO, can be used to re-customize plug-ins, etc.
-- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents
+- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update time)
 - [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it in Docker
 - [Development Stories](https://jaywhj.netlify.app/document-dates-en#Development-Stories): Describes the origin of the plug-in, the difficulties and solutions encountered in development, and the principles and directions of product design
 

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7}/mkdocs_document_dates/plugin.py

@@ -16,21 +16,12 @@ logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
 
 
 class Author:
-    def __init__(self, name="", email="", avatar="", url="", desc=""):
+    def __init__(self, name="", email="", avatar="", url="", description="", **kwargs):
         self.name = name
         self.email = email
         self.avatar = avatar
         self.url = url
-        self.desc = desc
-    
-    def to_dict(self):
-        return {
-            'name': self.name,
-            'email': self.email,
-            'avatar': self.avatar,
-            'url': self.url,
-            'description': self.desc
-        }
+        self.description = description
 
 
 class DocumentDatesPlugin(BasePlugin):
@@ -264,14 +255,7 @@ class DocumentDatesPlugin(BasePlugin):
             with open(file_path, 'r', encoding='utf-8') as f:
                 data = yaml.safe_load(f)
             for key, info in (data or {}).get('authors', {}).items():
-                author = Author(
-                    name=info.get('name', ''),
-                    email=info.get('email', ''),
-                    avatar=info.get('avatar', ''),
-                    url=info.get('url', ''),
-                    desc=info.get('description', '')
-                )
-                self.authors_yml[key] = author
+                self.authors_yml[key] = Author(**info)
         except Exception as e:
             logger.info(f"Error parsing .authors.yml: {e}")
 
@@ -314,9 +298,23 @@ class DocumentDatesPlugin(BasePlugin):
         if rel_path in self.dates_cache:
             authors_list = self.dates_cache[rel_path].get('authors')
             if authors_list:
-                return [Author(**dict) for dict in authors_list]
+                authors = []
+                for dict in authors_list:
+                    full_author = self.authors_yml.get(dict['name'])
+                    if full_author:
+                        authors.append(full_author)
+                        # authors.append(Author(**{**vars(full_author), **dict}))
+                    else:
+                        authors.append(Author(**dict))
+                return authors
         # 3. site_author 或 PC username
-        return [Author(name=config.get('site_author') or Path.home().name)]
+        name = config.get('site_author') or Path.home().name
+        full_author = self.authors_yml.get(name)
+        if full_author:
+            return [full_author]
+            # return [Author(**{**vars(full_author), "name": name})]
+        else:
+            return [Author(name=name)]
 
     def _process_meta_author(self, meta):
         try:
@@ -331,27 +329,18 @@ class DocumentDatesPlugin(BasePlugin):
             if author_objs:
                 return author_objs
 
-            # 匹配 author 对象，或 author 字符串
-            author_data = meta.get('author')
-            if author_data:
-                if isinstance(author_data, dict):
-                    name = author_data.get('name')
-                    if not name:
-                        return None
-                    email = author_data.get('email')
-                    avatar = author_data.get('avatar')
-                    url = author_data.get('url')
-                    desc = author_data.get('description')
-                    return [Author(name=name, email=email, avatar=avatar, url=url, desc=desc)]
-                return [Author(name=str(author_data))]
-
             # 匹配独立字段: name, email
             name = meta.get('name')
             email = meta.get('email')
             if name or email:
                 if not name and email:
                     name = email.partition('@')[0]
-                return [Author(name=name, email=email)]
+                full_author = self.authors_yml.get(name)
+                if full_author:
+                    return [full_author]
+                    # return [Author(**{**vars(full_author), "name": name, "email": email or full_author.email})]
+                else:
+                    return [Author(name=name, email=email)]
         except Exception as e:
             logger.warning(f"Error processing author meta: {e}")
         return None
@@ -422,7 +411,7 @@ class DocumentDatesPlugin(BasePlugin):
                         html_parts.append(
                             f"<div class='avatar-wrapper' data-name='{author.name}' data-tippy-content data-tippy-raw='{tooltip}'>"
                             f"<span class='avatar-text'></span>"
-                            f"<img class='avatar' src='{img_url}' />"
+                            f"<img class='avatar' src='{img_url}' onerror=\"this.style.display='none'\" />"
                             f"</div>"
                         )
                     html_parts.append("</div>")

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7}/mkdocs_document_dates/static/core/core.js

@@ -1,5 +1,5 @@
 /*
-    1.生成字符头像
+    1.生成头像
 */
 function isLatin(name) {
     return /^[A-Za-z\s]+$/.test(name.trim());
@@ -35,9 +35,7 @@ function generateAvatar() {
         const imgEl = wrapper.querySelector('img.avatar');
         if (imgEl) {
             const src = (imgEl.getAttribute('src') || '').trim();
-            if (src) {
-                imgEl.onerror = () => imgEl.style.display = 'none';
-            } else {
+            if (!src) {
                 imgEl.style.display = 'none';
             }
         }

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7}/mkdocs_document_dates/static/templates/recently_updated.html

@@ -16,9 +16,9 @@
 .recently-updated-item span {
     font-size: 0.85em;
     color: rgba(142, 142, 142, 0.5);
-    margin-right: 8px;
+    margin-right: 5px;
     flex-shrink: 0;
-    width: 90px;
+    width: 95px;
 }
 .recently-updated-item a {
     overflow: hidden;

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7}/mkdocs_document_dates/utils.py

@@ -62,9 +62,9 @@ def load_git_cache(docs_dir_path: Path):
                     current_commit = tuple(line.split('|', 2))
                 elif line.endswith('.md') and current_commit:
                     name, email, created = current_commit
-                    # 使用 defaultdict(dict)结构，有序去重，保持作者首次出现的顺序
+                    # 使用 defaultdict(dict)结构，处理有序与去重
                         # a.巧用 Python 字典的 setdefault 特性来去重（setdefault 为不存在的键提供初始值，不会覆盖已有值）
-                        # b.巧用 Python 3.7+ 字典的插入顺序特性来保留内容插入顺序（Python 3.7+ 字典会保持插入顺序）
+                        # b.巧用 Python 字典的插入顺序特性来保留内容插入顺序（Python 3.7+ 字典会保持插入顺序）
                     authors_dict[line].setdefault((name, email), None)
                     first_commit.setdefault(line, created)
 
@@ -102,7 +102,7 @@ def get_file_creation_time(file_path):
 def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list: list, limit: int = 10, recent_enable: bool = False):
     doc_mtime_map = {}
     try:
-        # 1. 获取 git 信息，只记录已跟踪的文件首次出现的信息（最近一次提交时间）
+        # 1. 获取 git 信息，只记录已跟踪的文件最近一次的提交信息
         git_root = Path(subprocess.check_output(
             ['git', 'rev-parse', '--show-toplevel'],
             cwd=docs_dir_path, encoding='utf-8'
@@ -123,7 +123,7 @@ def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list:
                 line = line.strip()
                 if not line:
                     continue
-                if '|' in line:  # commit header
+                if '|' in line:
                     ts = float(line.split('|')[2])
                 elif line.endswith('.md') and line in tracked_files and ts:
                     # 只记录第一次出现的文件，即最近一次提交（setdefault 机制不会覆盖已有值）

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.5
+Version: 3.4.7
 Summary: A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -37,13 +37,14 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 ## Features
 
 - [x] Always displays **exact** meta information of the document and works in any environment (no Git, Git environments, Docker containers, all CI/CD build systems, etc.)
+- [x] Support list display of recently updated documents (in descending order of update time)
 - [x] Support for manually specifying time and author in `Front Matter`
 - [x] Support for multiple time formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
+- [x] Support for manually configuring author's name, link, avatar, email, etc.
 - [x] Flexible display position (top or bottom)
 - [x] Elegant styling (fully customizable)
 - [x] Smart Tooltip Hover Tips
-- [x] Support list display of recently updated documents
 - [x] Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
 - [x] Cross-platform support (Windows, macOS, Linux)
 - [x] **Ultimate build efficiency**: O(1), no need to set env vars to distinguish runs
@@ -81,7 +82,6 @@ plugins:
       date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
       show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
-      recently-updated: true   # Whether to turn on recently updated data, default: false
 ```
 
 ## Customization Settings
@@ -89,12 +89,12 @@ plugins:
 In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:
 
 - [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): You can manually specify the creation time and last update time for each document
-- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document
+- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document, such as name, link, avatar, email, etc.
 - [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author
 - [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): Such as icons, themes, colors, fonts, animations, dividing line, etc.
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [Use Template Variables](https://jaywhj.netlify.app/document-dates-en#Use-Template-Variables): Can be used to optimize `sitemap.xml` for site SEO, can be used to re-customize plug-ins, etc.
-- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents
+- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update time)
 - [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it in Docker
 - [Development Stories](https://jaywhj.netlify.app/document-dates-en#Development-Stories): Describes the origin of the plug-in, the difficulties and solutions encountered in development, and the principles and directions of product design
 

{mkdocs_document_dates-3.4.5 → mkdocs_document_dates-3.4.7}/setup.py

@@ -23,7 +23,7 @@ class CustomInstallCommand(install):
         install.run(self)
 
 
-VERSION = '3.4.5'
+VERSION = '3.4.7'
 
 setup(
     name="mkdocs-document-dates",