mkdocs-document-dates 3.4.6__tar.gz → 3.4.8__tar.gz

{mkdocs_document_dates-3.4.6/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.6
+Version: 3.4.8
 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
@@ -41,14 +41,15 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 - [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] 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
+- [x] **Ultimate build efficiency**: O(1), no need to set the env var `!ENV` to distinguish runs
 
-| PK of Build Efficiency:     | 100 md: | 1000 md: | Time Complexity: |
+| Build Speed Comparison:     | 100 md: | 1000 md: | Time Complexity: |
 | --------------------------- | :-----: | :------: | :----------: |
 | git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
@@ -88,7 +89,7 @@ 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` 

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8}/README.md

@@ -15,14 +15,15 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 - [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] 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
+- [x] **Ultimate build efficiency**: O(1), no need to set the env var `!ENV` to distinguish runs
 
-| PK of Build Efficiency:     | 100 md: | 1000 md: | Time Complexity: |
+| Build Speed Comparison:     | 100 md: | 1000 md: | Time Complexity: |
 | --------------------------- | :-----: | :------: | :----------: |
 | git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
@@ -62,7 +63,7 @@ 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` 

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8}/mkdocs_document_dates/cache_manager.py

@@ -1,7 +1,7 @@
 import logging
 import subprocess
 from pathlib import Path
-from .utils import read_json_cache, read_jsonl_cache, write_jsonl_cache, get_file_creation_time, get_git_first_commit_time
+from .utils import read_jsonl_cache, write_jsonl_cache, get_file_creation_time, get_git_first_commit_time
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
@@ -72,29 +72,21 @@ def update_cache():
                 logger.info(f"No tracked markdown files found in {docs_dir}")
                 continue
 
-            # 读取旧的JSON缓存文件（如果存在）
-            json_cache_file = docs_dir / '.dates_cache.json'
-            json_dates_cache = read_json_cache(json_cache_file)
-
-            # 读取新的JSONL缓存文件（如果存在）
+            # 读取 JSONL 缓存
             jsonl_cache_file = docs_dir / '.dates_cache.jsonl'
             jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
 
             # 根据 git已跟踪的文件来更新
             for rel_path in tracked_files:
                 try:
-                    # 如果文件已在JSONL缓存中，跳过
+                    # 如果文件已在 JSONL 缓存中，跳过
                     if rel_path in jsonl_dates_cache:
                         continue
 
                     full_path = docs_dir / rel_path
-                    # 处理新文件或迁移旧JSON缓存
-                    if rel_path in json_dates_cache:
-                        jsonl_dates_cache[rel_path] = json_dates_cache[rel_path]
-                        project_updated = True
-                    elif full_path.exists():
+                    if full_path.exists():
                         created_time = get_file_creation_time(full_path).astimezone()
-                        if not jsonl_cache_file.exists() and not json_cache_file.exists():
+                        if not jsonl_cache_file.exists():
                             git_time = get_git_first_commit_time(full_path)
                             if git_time:
                                 created_time = min(created_time, git_time)
@@ -110,7 +102,7 @@ def update_cache():
             if len(jsonl_dates_cache) > len(tracked_files):
                 project_updated = True
 
-            # 如果有更新，写入JSONL缓存文件
+            # 如果有更新，写入 JSONL 缓存文件
             if project_updated or not jsonl_cache_file.exists():
                 global_updated = write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files)
         except subprocess.CalledProcessError as e:

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8}/mkdocs_document_dates/plugin.py

@@ -8,6 +8,7 @@ from pathlib import Path
 from mkdocs.plugins import BasePlugin
 from mkdocs.config import config_options
 from mkdocs.structure.pages import Page
+from mkdocs.utils import get_relative_url
 from urllib.parse import urlparse
 from .utils import get_file_creation_time, load_git_cache, read_jsonl_cache,is_excluded, get_recently_updated_files
 
@@ -16,21 +17,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):
@@ -173,31 +165,6 @@ class DocumentDatesPlugin(BasePlugin):
 
         return nav
 
-    def _render_recently_updated_html(self, docs_dir, template_path, recently_updated_data):
-        # 获取自定义模板路径
-        if template_path:
-            user_full_path = docs_dir / template_path
-
-        # 选择模板路径
-        if template_path and user_full_path.is_file():
-            template_dir = user_full_path.parent
-            template_file = user_full_path.name
-        else:
-            # 默认模板路径
-            default_template_path = Path(__file__).parent / 'static' / 'templates' / 'recently_updated.html'
-            template_dir = default_template_path.parent
-            template_file = default_template_path.name
-
-        # 加载模板
-        env = Environment(
-            loader=FileSystemLoader(str(template_dir)),
-            autoescape=select_autoescape(["html", "xml"])
-        )
-        template = env.get_template(template_file)
-
-        # 渲染模板
-        return template.render(recent_docs=recently_updated_data)
-
     def on_page_markdown(self, markdown, page: Page, config, files):
         # 获取相对路径，src_uri 总是以"/"分隔
         rel_path = getattr(page.file, 'src_uri', page.file.src_path)
@@ -215,6 +182,10 @@ class DocumentDatesPlugin(BasePlugin):
         
         # 获取作者信息
         authors = self._get_author_info(rel_path, page, config)
+        if len(authors) == 1:
+            a = authors[0]
+            if not a.avatar and self.github_username:
+                a.avatar = f"https://avatars.githubusercontent.com/{self.github_username}"
         
         # 在排除前暴露 meta 信息给前端使用
         page.meta['document_dates_created'] = created.isoformat()
@@ -246,6 +217,7 @@ class DocumentDatesPlugin(BasePlugin):
                 if item.is_file():
                     shutil.copy2(item, target_dir / item.name)
 
+
     def _extract_github_username(self, url):
         try:
             parsed = urlparse(url)
@@ -264,18 +236,37 @@ 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}")
 
 
+    def _render_recently_updated_html(self, docs_dir, template_path, recently_updated_data):
+        # 获取自定义模板路径
+        if template_path:
+            user_full_path = docs_dir / template_path
+
+        # 选择模板路径
+        if template_path and user_full_path.is_file():
+            template_dir = user_full_path.parent
+            template_file = user_full_path.name
+        else:
+            # 默认模板路径
+            default_template_path = Path(__file__).parent / 'static' / 'templates' / 'recently_updated.html'
+            template_dir = default_template_path.parent
+            template_file = default_template_path.name
+
+        # 加载模板
+        env = Environment(
+            loader=FileSystemLoader(str(template_dir)),
+            autoescape=select_autoescape(["html", "xml"])
+        )
+        template = env.get_template(template_file)
+
+        # 渲染模板
+        return template.render(recent_docs=recently_updated_data)
+
+
     def _find_meta_date(self, meta, field_names):
         for field in field_names:
             if field in meta:
@@ -307,55 +298,73 @@ class DocumentDatesPlugin(BasePlugin):
         if not self.config['show_author']:
             return None
         # 1. meta author
-        authors = self._process_meta_author(page.meta)
+        authors = self._process_meta_author(page.meta, page.url)
         if authors:
             return authors
+
         # 2. git author
         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 data in authors_list:
+                    full_author = self.authors_yml.get(data['name'])
+                    if full_author:
+                        authors.append(self._get_repaired_author(full_author, page.url))
+                    else:
+                        authors.append(Author(**data))
+                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 [self._get_repaired_author(full_author, page.url)]
+        else:
+            return [Author(name=name)]
 
-    def _process_meta_author(self, meta):
+    def _process_meta_author(self, meta, page_url):
         try:
             # 匹配 authors 数组
             author_objs = []
             authors_data = meta.get('authors')
             for key in authors_data or []:
-                author = self.authors_yml.get(key)
-                if not author:
-                    author = Author(name=str(key))
-                author_objs.append(author)
+                full_author = self.authors_yml.get(key)
+                if full_author:
+                    author_objs.append(self._get_repaired_author(full_author, page_url))
+                else:
+                    author_objs.append(Author(name=str(key)))
             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 [self._get_repaired_author(full_author, page_url)]
+                else:
+                    return [Author(name=name, email=email)]
         except Exception as e:
             logger.warning(f"Error processing author meta: {e}")
         return None
 
+    def _get_repaired_author(self, author: Author, page_url: str) -> Author:
+        try:
+            if not author.avatar:
+                return author
+            parsed = urlparse(author.avatar)
+            if parsed.scheme or author.avatar.startswith('//'):
+                return author
+            # 处理本地路径（相对路径 & 绝对路径）
+            avatar = get_relative_url(author.avatar.lstrip('/'), page_url or '')
+            return Author(**{**vars(author), 'avatar': avatar})
+        except Exception:
+            return author
+
 
     def _get_formatted_date(self, date: datetime):
         if self.config['type'] == 'timeago':
@@ -393,13 +402,6 @@ class DocumentDatesPlugin(BasePlugin):
                         return f'<a href="mailto:{author.email}">{author.name}</a>'
                     return author.name
 
-                def get_avatar_img_url(author):
-                    if author.avatar:
-                        return author.avatar
-                    elif self.github_username and len(authors) == 1:
-                        return f"https://avatars.githubusercontent.com/{self.github_username}"
-                    return ""
-
                 if self.config['show_author'] == 'text':
                     # 显示文本模式
                     tooltip_text = ',&nbsp;'.join(get_author_tooltip(author) for author in authors)
@@ -418,11 +420,10 @@ class DocumentDatesPlugin(BasePlugin):
                     html_parts.append("<div class='avatar-group'>")
                     for author in authors:
                         tooltip = get_author_tooltip(author)
-                        img_url = get_avatar_img_url(author)
                         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' data-src='{img_url}' />"
+                            f"<img class='avatar' src='{author.avatar}' onerror=\"this.style.display='none'\" />"
                             f"</div>"
                         )
                     html_parts.append("</div>")
@@ -437,14 +438,14 @@ class DocumentDatesPlugin(BasePlugin):
 
     def _insert_date_info(self, markdown: str, date_info: str):
         if self.config['position'] == 'top':
-            first_line, insert_pos = self.find_markdown_body_start(markdown)
+            first_line, insert_pos = self._find_markdown_body_start(markdown)
             if first_line.startswith(('# ', '<h1')):
                 return markdown[:insert_pos] + '\n' + date_info + '\n' + markdown[insert_pos:]
             else:
                 return f"{date_info}\n{markdown}"
         return f"{markdown}\n\n{date_info}"
 
-    def find_markdown_body_start(self, text: str):
+    def _find_markdown_body_start(self, text: str):
         pos = 0
         length = len(text)
         in_comment = False

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8}/mkdocs_document_dates/static/core/core.js

@@ -34,12 +34,8 @@ function generateAvatar() {
 
         const imgEl = wrapper.querySelector('img.avatar');
         if (imgEl) {
-            // 先设置 onerror，再设置 src（设置src时就会立即触发加载）
-            imgEl.onerror = () => imgEl.style.display = 'none';
-            const dataSrc = (imgEl.getAttribute('data-src') || '').trim();
-            if (dataSrc) {
-                imgEl.src = dataSrc;
-            } else {
+            const src = (imgEl.getAttribute('src') || '').trim();
+            if (!src) {
                 imgEl.style.display = 'none';
             }
         }

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8}/mkdocs_document_dates/utils.py

@@ -171,16 +171,6 @@ def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list:
 
     return doc_mtime_map, recently_updated_results
 
-def read_json_cache(cache_file: Path):
-    dates_cache = {}
-    if cache_file.exists():
-        try:
-            with open(cache_file, 'r', encoding='utf-8') as f:
-                dates_cache = json.load(f)
-        except (IOError, json.JSONDecodeError) as e:
-            logger.warning(f"Error reading from '.dates_cache.json': {str(e)}")
-    return dates_cache
-
 def read_jsonl_cache(jsonl_file: Path):
     dates_cache = {}
     if jsonl_file.exists():

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.6
+Version: 3.4.8
 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
@@ -41,14 +41,15 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 - [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] 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
+- [x] **Ultimate build efficiency**: O(1), no need to set the env var `!ENV` to distinguish runs
 
-| PK of Build Efficiency:     | 100 md: | 1000 md: | Time Complexity: |
+| Build Speed Comparison:     | 100 md: | 1000 md: | Time Complexity: |
 | --------------------------- | :-----: | :------: | :----------: |
 | git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
@@ -88,7 +89,7 @@ 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` 

{mkdocs_document_dates-3.4.6 → mkdocs_document_dates-3.4.8}/setup.py

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