mkdocs-document-dates 3.8.2__tar.gz → 3.8.6__tar.gz

{mkdocs_document_dates-3.8.2/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.8.2
+Version: 3.8.6
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
 Author-email: Aaron Wang <aaronwqt@gmail.com>
 License-Expression: MIT
@@ -14,6 +14,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mkdocs<=1.6.1,>=1.6
 Requires-Dist: properdocs>=1.6.5
+Requires-Dist: babel>=2.16
 Dynamic: license-file
 
 # mkdocs-document-dates

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/mkdocs_document_dates/plugin.py

@@ -9,6 +9,7 @@ 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 babel.dates import format_datetime
 from .utils import compile_exclude_patterns, is_excluded, get_recently_updated_files, load_dates_and_authors
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
@@ -54,7 +55,7 @@ class DocumentDatesPlugin(BasePlugin):
 
         # 加载 author 配置
         authors_file = None
-        for name in ("authors.yml", "authors.yaml"):
+        for name in ('authors.yml', 'authors.yaml'):
             candidate = docs_dir_path / name
             if candidate.exists():
                 authors_file = candidate
@@ -71,17 +72,7 @@ class DocumentDatesPlugin(BasePlugin):
         if authors_file:
             self._load_authors_from_yaml(authors_file)
 
-        # 复制配置文件到用户目录（如果不存在）
-        dest_dir = docs_dir_path / 'assets' / 'document_dates'
-        dest_dir.mkdir(parents=True, exist_ok=True)
-        config_files = ['user.config.css', 'user.config.js']
-        for config_file in config_files:
-            source_config = Path(__file__).parent / 'static' / 'config' / config_file
-            target_config = dest_dir / config_file
-            if not target_config.exists():
-                shutil.copy2(source_config, target_config)
-
-        # 添加离线 Google Fonts Icons: https://fonts.google.com/icons
+        # 添加离线 Google Fonts Icons, https://fonts.google.com/icons
         # material_icons_url = 'https://fonts.googleapis.com/icon?family=Material+Icons'
         material_icons_url = 'assets/document_dates/fonts/material-icons.css'
         config['extra_css'].append(material_icons_url)
@@ -118,23 +109,36 @@ class DocumentDatesPlugin(BasePlugin):
         tippy_css_dir = Path(__file__).parent / 'static' / 'tippy'
         for css_file in tippy_css_dir.glob('*.css'):
             config['extra_css'].append(f'assets/document_dates/tippy/{css_file.name}')
-        
-        # 添加自定义 CSS 文件
-        config['extra_css'].extend([
-            'assets/document_dates/core/core.css',
-            'assets/document_dates/user.config.css'
-        ])
-        
+
+        # User override config
+        override_dir = docs_dir_path / 'assets' / 'document_dates'
+        override_css = override_dir / 'config.css'
+        override_js = override_dir / 'config.js'
+
+        # Plugin CSS
+        config['extra_css'].append('assets/document_dates/core/core.css')
+
+        # 用户 override CSS（可选）
+        if override_css.exists():
+            config['extra_css'].append('assets/document_dates/config.css')
+
         # 按顺序添加 Tippy JS 文件
         js_core_files = ['popper.min.js', 'tippy.umd.min.js']
         for js_file in js_core_files:
             config['extra_javascript'].append(f'assets/document_dates/tippy/{js_file}')
-        
-        # 添加自定义 JS 文件
+
+        # Plugin 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',
+        ])
+
+        # 用户 override JS（可选）
+        if override_js.exists():
+            config['extra_javascript'].append('assets/document_dates/config.js')
+
+        # core runtime
+        config['extra_javascript'].extend([
             'assets/document_dates/core/utils.js',
             'assets/document_dates/core/core.js'
         ])
@@ -185,10 +189,14 @@ class DocumentDatesPlugin(BasePlugin):
         # 检查是否需要排除
         if is_excluded(rel_path, self._exclude_patterns):
             return markdown
-        
+
+        # 增强鲁棒性，碰到异常数据提前返回
+        if not created or not updated:
+            return markdown
+
         # 生成日期和作者信息 HTML
         info_html = self._generate_html_info(page.meta, created, updated, authors)
-        
+
         # 将信息写入 markdown
         return self._insert_date_info(markdown, info_html)
 
@@ -367,11 +375,38 @@ class DocumentDatesPlugin(BasePlugin):
 
 
     def _formatting_date(self, date: datetime):
-        if self.config['type'] == 'timeago':
-            return ""
-        elif self.config['type'] == 'datetime':
-            return date.strftime(f"{self.config['date_format']} {self.config['time_format']}")
-        return date.strftime(self.config['date_format'])
+        locale = self.config.get('locale', 'en')
+
+        # 兼容旧 strftime 配置，转换为 Babel/ICU 格式
+        date_format = (
+            self.config['date_format']
+            .replace('%Y', 'yyyy')
+            .replace('%y', 'yy')
+            .replace('%m', 'MM')
+            .replace('%d', 'dd')
+            .replace('%B', 'MMMM')
+            .replace('%b', 'MMM')
+        )
+
+        time_format = (
+            self.config['time_format']
+            .replace('%H', 'HH')
+            .replace('%I', 'hh')
+            .replace('%M', 'mm')
+            .replace('%S', 'ss')
+            .replace('%p', 'a')
+        )
+
+        if self.config['type'] == 'datetime':
+            fmt = f"{date_format} {time_format}"
+        else:
+            fmt = date_format
+
+        return format_datetime(
+            date,
+            format=fmt,
+            locale=locale
+        )
 
     def _generate_html_info(self, meta, created: datetime, updated: datetime, authors=None):
         try:
@@ -391,11 +426,11 @@ class DocumentDatesPlugin(BasePlugin):
             html_parts.append(f"<div class='document-dates-plugin' locale='{self.config['locale']}'>")
 
             def build_time_icon(time_obj: datetime, icon: str):
-                formatted = time_obj.strftime(self.config['date_format'])
+                formatted = self._formatting_date(time_obj)
                 return (
                     f"<span class='dd-item' data-tippy-content data-tippy-raw='{formatted}'>"
                     f"<span class='material-icons' data-icon='{icon}'></span>"
-                    f"<time datetime='{time_obj.astimezone().isoformat()}'>{self._formatting_date(time_obj)}</time>"
+                    f"<time datetime='{time_obj.astimezone().isoformat()}'>{formatted}</time>"
                     f"</span>"
                 )
 

mkdocs_document_dates-3.8.2/mkdocs_document_dates/static/config/user.config.css → mkdocs_document_dates-3.8.6/mkdocs_document_dates/static/config/config.css

@@ -69,7 +69,7 @@
     font-size: 12px;
 } */
 
-/* Demo of the custom theme 'sorrel' and 'sublime', you can configure it in user.config.js (optional) */
+/* Demo of the custom theme 'sorrel' and 'sublime', you can configure it in config.js (optional) */
 /* 
 .tippy-box[data-theme~='sorrel'] {
     background-color: #F7E6E2;

mkdocs_document_dates-3.8.2/mkdocs_document_dates/static/config/user.config.js → mkdocs_document_dates-3.8.6/mkdocs_document_dates/static/config/config.js

@@ -14,7 +14,7 @@ Part 1:
 /*
 TooltipConfig.setConfig({
     theme: {
-        // configurable: light material, or custom theme in user.config.css, for example: sorrel sublime tomato
+        // configurable: light material, or custom theme in config.css, for example: sorrel sublime tomato
         light: 'light',
         dark: 'material'
     },

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/mkdocs_document_dates/static/core/default.config.js

@@ -2,7 +2,7 @@
     Tooltip 配置
 */
 const ttDefaultConfig = {
-    // 可配置: light material, 或在 user.config.css 中自定义的主题
+    // 可配置: light material, 或在 config.css 中自定义的主题
     theme: {
         light: 'light',
         dark: 'material'

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/mkdocs_document_dates/utils.py

@@ -103,6 +103,24 @@ def load_git_first_commit_date(file_path) -> datetime:
         logger.info(f"Error load git first commit date for {file_path}: {e}")
     return datetime.now(timezone.utc)
 
+COAUTHOR_RE = re.compile(
+    r'^Co-authored-by:\s*(.+?) <([^<>]+)>$',
+    re.MULTILINE | re.IGNORECASE
+)
+def parse_commit_authors(name, email, body):
+    authors = [(name, email)]
+    seen = {(name, email)}
+
+    for co_name, co_email in COAUTHOR_RE.findall(body):
+        author = (co_name, co_email)
+        if author in seen:
+            continue
+
+        seen.add(author)
+        authors.append(author)
+
+    return authors
+
 def load_git_metadata(docs_dir_path: Path):
     dates_cache = {}
     try:
@@ -110,28 +128,53 @@ def load_git_metadata(docs_dir_path: Path):
             ['git', 'rev-parse', '--show-toplevel'],
             cwd=docs_dir_path, encoding='utf-8'
         ).strip())
-        rel_docs_path = docs_dir_path.relative_to(git_root).as_posix()
+        rel_docs_path = docs_dir_path.relative_to(git_root)
 
-        cmd = ['git', '-c', 'core.quotepath=false', 'log', '--reverse', '--no-merges', '--use-mailmap', '--name-only', '--format=%aN|%aE|%at', f'--relative={rel_docs_path}', '--', '*.md']
+        relative_arg = (
+            '--relative'
+            if rel_docs_path == Path('.')
+            else f'--relative={rel_docs_path.as_posix()}'
+        )
+        cmd = [
+            'git',
+            '-c', 'core.quotepath=false',
+            'log',
+            '--reverse',
+            '--no-merges',
+            '--use-mailmap',
+            '--name-only',
+            '-z',
+            '--format=%aN%x1f%aE%x1f%at%x1f%B%x00',
+            relative_arg,
+            '--',
+            '*.md'
+        ]
         process = subprocess.run(cmd, cwd=docs_dir_path, capture_output=True, encoding='utf-8')
         if process.returncode == 0:
             authors_dict = defaultdict(dict)
             first_commit = {}
             current_commit = None
-            for line in process.stdout.splitlines():
-                line = line.strip()
-                if not line:
+
+            records = process.stdout.split('\x00')
+            for item in records:
+                item = item.strip()
+                if not item:
                     continue
-                if '|' in line:
-                    # 使用元组，更轻量
-                    current_commit = tuple(line.split('|', 2))
-                elif line.endswith('.md') and current_commit:
-                    name, email, created = current_commit
+
+                parts = item.split('\x1f', 3)
+                if len(parts) == 4:
+                    name, email, created, body = parts
+                    authors = parse_commit_authors(name, email, body)
+                    current_commit = (authors, int(created))
+                elif item.endswith('.md') and current_commit:
+                    authors, created = current_commit
                     # 使用 defaultdict(dict)结构，处理有序与去重
                         # a.巧用 Python 字典的 setdefault 特性来去重（setdefault 为不存在的键提供初始值，不会覆盖已有值）
                         # b.巧用 Python 字典的插入顺序特性来保留内容插入顺序（Python 3.7+ 字典会保持插入顺序）
-                    authors_dict[line].setdefault((name, email), None)
-                    first_commit.setdefault(line, int(created))
+                    for author in authors:
+                        authors_dict[item].setdefault(author, None)
+
+                    first_commit.setdefault(item, created)
 
             # 构建最终的缓存数据
             for file_path in first_commit:
@@ -154,9 +197,14 @@ def load_git_last_updated_dates(docs_dir_path: Path):
             ['git', 'rev-parse', '--show-toplevel'],
             cwd=docs_dir_path, encoding='utf-8'
         ).strip())
-        rel_docs_path = docs_dir_path.relative_to(git_root).as_posix()
+        rel_docs_path = docs_dir_path.relative_to(git_root)
 
-        cmd = ['git', '-c', 'core.quotepath=false', 'log', '--no-merges', '--use-mailmap', '--format=%aN|%aE|%at', '--name-only', f'--relative={rel_docs_path}', '--', '*.md']
+        relative_arg = (
+            '--relative'
+            if rel_docs_path == Path('.')
+            else f'--relative={rel_docs_path.as_posix()}'
+        )
+        cmd = ['git', '-c', 'core.quotepath=false', 'log', '--no-merges', '--use-mailmap', '--format=%aN|%aE|%at', '--name-only', relative_arg, '--', '*.md']
         process = subprocess.run(cmd, cwd=docs_dir_path, capture_output=True, encoding='utf-8')
         if process.returncode == 0:
             result = subprocess.run(

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.8.2
+Version: 3.8.6
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
 Author-email: Aaron Wang <aaronwqt@gmail.com>
 License-Expression: MIT
@@ -14,6 +14,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mkdocs<=1.6.1,>=1.6
 Requires-Dist: properdocs>=1.6.5
+Requires-Dist: babel>=2.16
 Dynamic: license-file
 
 # mkdocs-document-dates

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/mkdocs_document_dates.egg-info/SOURCES.txt

@@ -16,8 +16,8 @@ mkdocs_document_dates.egg-info/requires.txt
 mkdocs_document_dates.egg-info/top_level.txt
 mkdocs_document_dates/hooks/pre-commit
 mkdocs_document_dates/static/.DS_Store
-mkdocs_document_dates/static/config/user.config.css
-mkdocs_document_dates/static/config/user.config.js
+mkdocs_document_dates/static/config/config.css
+mkdocs_document_dates/static/config/config.js
 mkdocs_document_dates/static/core/core.css
 mkdocs_document_dates/static/core/core.js
 mkdocs_document_dates/static/core/default.config.js

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/mkdocs_document_dates.egg-info/requires.txt

@@ -1,2 +1,3 @@
 mkdocs<=1.6.1,>=1.6
 properdocs>=1.6.5
+babel>=2.16

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mkdocs-document-dates"
-version = "3.8.2"
+version = "3.8.6"
 description = "A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.7"
@@ -12,7 +12,8 @@ license = "MIT"
 authors = [{ name = "Aaron Wang", email = "aaronwqt@gmail.com" }]
 dependencies = [
   "mkdocs>=1.6,<=1.6.1",
-  "properdocs>=1.6.5"
+  "properdocs>=1.6.5",
+  "babel>=2.16"
 ]
 classifiers = [
   "Programming Language :: Python :: 3",

{mkdocs_document_dates-3.8.2 → mkdocs_document_dates-3.8.6}/setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 def legacy_setup():
     setup(
         name="mkdocs-document-dates",
-        version="3.8.2",
+        version="3.8.6",
         author="Aaron Wang",
         author_email="aaronwqt@gmail.com",
         license="MIT",
@@ -15,7 +15,9 @@ def legacy_setup():
         packages=find_packages(),
         include_package_data=True,
         install_requires=[
-            "mkdocs>=1.1.0",
+            "mkdocs>=1.6,<=1.6.1",
+            "properdocs>=1.6.5",
+            "babel>=2.16"
         ],
         classifiers=[
             "Programming Language :: Python :: 3",