mkdocs-document-dates 3.5.1__tar.gz → 3.6.0__tar.gz

{mkdocs_document_dates-3.5.1/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.5.1
+Version: 3.6.0
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -79,9 +79,6 @@ plugins:
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
       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_created: true       # Show creation date: true false, default: true
-      show_updated: true       # Show last updated date: true false, default: true
-      show_author: true        # Show author: true(avatar) text(text) false(hidden), default: true
 ```
 
 ## Customization Settings
@@ -91,7 +88,7 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 - [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): Introduces the mechanism for obtaining document dates and methods for personalized customization, you can manually specify the creation date and last updated date for each document
 - [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, 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, support local file path and URL path
-- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
+- [Configuration Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
 - [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 (in descending order of update date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
@@ -100,6 +97,12 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 
 See the documentation for details: https://jaywhj.netlify.app/document-dates-en
 
+<br />
+
+## Other Projects
+
+- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material, is based on `mkdocs-material-9.7.0` and is named `X`. I'll be maintaining this branch continuously (since mkdocs-material will stop being maintained). 
+Updates have been released that refactor and add a lot of new features, see https://github.com/jaywhj/mkdocs-materialx/releases/
 
 <br />
 

{mkdocs_document_dates-3.5.1 → mkdocs_document_dates-3.6.0}/README.md

@@ -53,9 +53,6 @@ plugins:
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
       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_created: true       # Show creation date: true false, default: true
-      show_updated: true       # Show last updated date: true false, default: true
-      show_author: true        # Show author: true(avatar) text(text) false(hidden), default: true
 ```
 
 ## Customization Settings
@@ -65,7 +62,7 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 - [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): Introduces the mechanism for obtaining document dates and methods for personalized customization, you can manually specify the creation date and last updated date for each document
 - [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, 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, support local file path and URL path
-- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
+- [Configuration Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
 - [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 (in descending order of update date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
@@ -74,6 +71,12 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 
 See the documentation for details: https://jaywhj.netlify.app/document-dates-en
 
+<br />
+
+## Other Projects
+
+- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material, is based on `mkdocs-material-9.7.0` and is named `X`. I'll be maintaining this branch continuously (since mkdocs-material will stop being maintained). 
+Updates have been released that refactor and add a lot of new features, see https://github.com/jaywhj/mkdocs-materialx/releases/
 
 <br />
 

{mkdocs_document_dates-3.5.1 → mkdocs_document_dates-3.6.0}/mkdocs_document_dates/plugin.py

@@ -46,7 +46,6 @@ class DocumentDatesPlugin(BasePlugin):
         self.dates_cache = {}
         self.last_updated_dates = {}
         self.authors_yml = {}
-        self.github_username = None
         self.recent_docs_html = None
         self.recent_enable = False
 
@@ -132,6 +131,7 @@ class DocumentDatesPlugin(BasePlugin):
         
         # 添加自定义 JS 文件
         config['extra_javascript'].extend([
+            'assets/document_dates/core/md5.min.js',
             'assets/document_dates/core/default.config.js',
             'assets/document_dates/user.config.js',
             'assets/document_dates/core/utils.js',
@@ -168,7 +168,7 @@ class DocumentDatesPlugin(BasePlugin):
             return markdown
         
         # 生成日期和作者信息 HTML
-        info_html = self._generate_html_info(created, updated, authors)
+        info_html = self._generate_html_info(page.meta, created, updated, authors)
         
         # 将信息写入 markdown
         return self._insert_date_info(markdown, info_html)
@@ -185,7 +185,6 @@ class DocumentDatesPlugin(BasePlugin):
         # 获取配置
         exclude_list = recently_updated_config.get('exclude', [])
         limit = recently_updated_config.get('limit', 10)
-        template_path = recently_updated_config.get('template')
 
         # 获取最近更新的文档数据
         recently_updated_docs = get_recently_updated_files(self.last_updated_dates, files, exclude_list, limit, self.recent_enable)
@@ -197,8 +196,7 @@ class DocumentDatesPlugin(BasePlugin):
 
         # 渲染HTML
         if self.recent_enable:
-            docs_dir = Path(config['docs_dir'])
-            self.recent_docs_html = self._render_recently_updated_html(docs_dir, template_path, recently_updated_docs)
+            self.recent_docs_html = self._render_recently_updated_html(recently_updated_docs)
 
         return env
 
@@ -232,20 +230,10 @@ class DocumentDatesPlugin(BasePlugin):
             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
+    def _render_recently_updated_html(self, recently_updated_data):
+        default_template_path = Path(__file__).parent / 'static' / 'templates' / 'recently_updated_group.html'
+        template_dir = default_template_path.parent
+        template_file = default_template_path.name
 
         # 加载模板
         env = Environment(
@@ -362,10 +350,14 @@ class DocumentDatesPlugin(BasePlugin):
             return date.strftime(f"{self.config['date_format']} {self.config['time_format']}")
         return date.strftime(self.config['date_format'])
 
-    def _generate_html_info(self, created: datetime, updated: datetime, authors=None):
+    def _generate_html_info(self, meta, created: datetime, updated: datetime, authors=None):
         try:
-            show_dates = self.config['show_created'] or self.config['show_updated']
-            show_plugin = show_dates or self.config['show_author']
+            show_created = self.config['show_created'] and meta.get('show_created') is not False
+            show_updated = self.config['show_updated'] and meta.get('show_updated') is not False
+            show_author  = self.config['show_author']  and meta.get('show_author')  is not False
+
+            show_dates = show_created or show_updated
+            show_plugin = show_dates or show_author
             if not show_plugin:
                 return ""
 
@@ -387,15 +379,15 @@ class DocumentDatesPlugin(BasePlugin):
             # 构建日期
             if show_dates:
                 html_parts.append("<div class='dd-left'>")
-            if self.config['show_created']:
+            if show_created:
                 html_parts.append(build_time_icon(created, 'doc_created'))
-            if self.config['show_updated']:
+            if show_updated:
                 html_parts.append(build_time_icon(updated, 'doc_updated'))
             if show_dates:
                 html_parts.append("</div>")
 
             # 构建作者
-            if self.config['show_author'] and authors:
+            if show_author and authors:
                 def get_author_tooltip(author):
                     if author.url:
                         return f'<a href="{author.url}" target="_blank">{author.name}</a>'
@@ -410,7 +402,8 @@ class DocumentDatesPlugin(BasePlugin):
                 icon = 'doc_author' if len(authors) == 1 else 'doc_authors'
                 html_parts.append(f"<span class='material-icons' data-icon='{icon}'></span>")
                 html_parts.append("<div class='author-group'>")
-                if self.config['show_author'] == 'text':
+                show_text = self.config['show_author'] == 'text' or meta.get('show_author') == 'text'
+                if show_text:
                     # 显示文本模式
                     for index, author in enumerate(authors):
                         if index > 0:
@@ -424,7 +417,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='{author.avatar}' onerror=\"this.style.display='none'\" />"
+                            f"<img class='avatar' data-src='{author.avatar}' data-email='{author.email}' />"
                             f"</div>"
                         )
                 html_parts.append("</div>")

{mkdocs_document_dates-3.5.1 → mkdocs_document_dates-3.6.0}/mkdocs_document_dates/static/core/core.css

@@ -23,11 +23,11 @@
     color: #666;
     font-size: 0.9rem;
     display: flex;
-    /* flex-wrap: nowrap; */
     align-items: center;
+    flex-wrap: nowrap;
     justify-content: space-between;
-    padding: 0.2rem 0;
-    margin-bottom: 0.6rem;
+    padding: 0.1rem 0;
+    margin-bottom: 0.5rem;
 }
 .md-main .document-dates-plugin {
     color: rgba(142, 142, 142, 0.7);
@@ -38,9 +38,6 @@
     font-size: 1rem;
     opacity: 0.85;
     margin-right: 0.3rem;
-    display: inline-flex;
-    align-items: center;
-    line-height: 1;
 }
 .md-main .document-dates-plugin .material-icons {
     font-size: 0.9rem;
@@ -70,17 +67,16 @@
 .dd-left {
     display: flex;
     align-items: center;
-    margin-right: 1.5rem;
+    flex-shrink: 0;
 }
 .dd-item {
     display: inline-flex;
     align-items: center;
     white-space: nowrap;
     flex-shrink: 0;
-    line-height: 1;
 }
 .dd-left > .dd-item + .dd-item {
-    margin-left: 1.5rem;
+    margin-left: 1.4rem;
 }
 
 .dd-right {
@@ -88,13 +84,25 @@
     align-items: center;
     justify-content: flex-end;
     flex: 1 1 auto;
-    min-width: 110px;
+    min-width: 0;
+    overflow: hidden;
 }
-
+/* Left-aligned when only dd-right */
 .dd-right.dd-right-start {
     justify-content: flex-start;
 }
 
+/* JS control toggle */
+.document-dates-plugin.is-wrapped {
+    flex-wrap: wrap;
+}
+.document-dates-plugin.is-wrapped .dd-right {
+    flex: 0 0 100%;
+    justify-content: flex-start;
+    margin-top: 10px;
+}
+
+
 /* ==========================================================================
    3. Author Avatar styles
    ========================================================================== */
@@ -111,9 +119,11 @@
 
     margin-right: 10px;
 
+    /* Hide Firefox, IE scrollbar */
     scrollbar-width: none;
     -ms-overflow-style: none;
 }
+/* Hide Chrome/Safari scrollbar */
 .author-group::-webkit-scrollbar {
     display: none;
 }
@@ -168,18 +178,6 @@
     flex-shrink: 0;
 }
 
-/* Optimize the experience with line breaks on very narrow screens */
-@media screen and (max-width: 359px) {
-    .document-dates-plugin {
-        flex-wrap: wrap;
-    }
-    .dd-right {
-        justify-content: flex-start;
-        width: 100%;
-        margin: 10px 0 0 0;
-    }
-}
-
 
 /* ==========================================================================
    4. Tooltip styles, including theme, arrow, font, color, background color, etc