mkdocs-document-dates 3.8.5__tar.gz → 3.8.7__tar.gz

{mkdocs_document_dates-3.8.5/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.8.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.8.5
+Version: 3.8.7
 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
@@ -102,7 +102,3 @@ Updates have been released that refactor and add a lot of new features, see http
 ## Chat Group
 
 **Discord**: https://discord.gg/cvTfge4AUy
-
-**Wechat**: 
-
-<img src="wechat-group.jpg" width="140" />

{mkdocs_document_dates-3.8.5 → mkdocs_document_dates-3.8.7}/README.md

@@ -83,7 +83,3 @@ Updates have been released that refactor and add a lot of new features, see http
 ## Chat Group
 
 **Discord**: https://discord.gg/cvTfge4AUy
-
-**Wechat**: 
-
-<img src="wechat-group.jpg" width="140" />

{mkdocs_document_dates-3.8.5 → mkdocs_document_dates-3.8.7}/mkdocs_document_dates/plugin.py

@@ -10,7 +10,7 @@ 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
+from .utils import compile_exclude_patterns, is_excluded, get_recently_updated_files, load_dates_and_authors, DEFAULT_WPM, DEFAULT_WPM_CJK
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
@@ -38,6 +38,8 @@ class DocumentDatesPlugin(BasePlugin):
         ('show_created', config_options.Type(bool, default=True)),
         ('show_updated', config_options.Type(bool, default=True)),
         ('show_author', config_options.Choice((True, False, 'text'), default=True)),
+        ('readtime_wpm', config_options.Type(int, default=DEFAULT_WPM)),
+        ('readtime_wpm_cjk', config_options.Type(int, default=DEFAULT_WPM_CJK)),
         ('recently-updated', config_options.Type((dict, bool), default={}))
     )
 
@@ -189,10 +191,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)
 
@@ -215,9 +221,13 @@ class DocumentDatesPlugin(BasePlugin):
         base_path = urlparse(site_url).path.rstrip("/")
         prefix = f"{base_path}/" if base_path else "/"
 
+        # 获取阅读速度 WPM 配置
+        wpm = self.config.get('readtime_wpm', DEFAULT_WPM)
+        wpm_cjk = self.config.get('readtime_wpm_cjk', DEFAULT_WPM_CJK)
+
         # 获取最近更新的文档数据
         recent_exclude_patterns = compile_exclude_patterns(exclude_list)
-        recently_updated_docs = get_recently_updated_files(self.data_cached, files, recent_exclude_patterns, limit, self.recent_enable, prefix)
+        recently_updated_docs = get_recently_updated_files(self.data_cached, files, recent_exclude_patterns, limit, self.recent_enable, prefix, wpm, wpm_cjk)
 
         # 将数据注入到 config['extra'] 中供全局访问
         if not config.get('extra', {}).get("recently_updated_docs", {}):

{mkdocs_document_dates-3.8.5 → mkdocs_document_dates-3.8.7}/mkdocs_document_dates/utils.py

@@ -17,6 +17,9 @@ logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
 
 
+DEFAULT_WPM = 240
+DEFAULT_WPM_CJK = 480
+
 def load_dates_and_authors(docs_dir_path: Path, files: Files):
 
     # git 创建日期
@@ -128,8 +131,13 @@ 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)
 
+        relative_arg = (
+            '--relative'
+            if rel_docs_path == Path('.')
+            else f'--relative={rel_docs_path.as_posix()}'
+        )
         cmd = [
             'git',
             '-c', 'core.quotepath=false',
@@ -140,7 +148,7 @@ def load_git_metadata(docs_dir_path: Path):
             '--name-only',
             '-z',
             '--format=%aN%x1f%aE%x1f%at%x1f%B%x00',
-            f'--relative={rel_docs_path}',
+            relative_arg,
             '--',
             '*.md'
         ]
@@ -192,9 +200,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(
@@ -220,7 +233,7 @@ def load_git_last_updated_dates(docs_dir_path: Path):
     return doc_mtime_map
 
 # 建议在 on_page_markdown 之后的全局事件中调用，因为需要读取 page.meta 中的信息
-def get_recently_updated_files(existing_dates: dict, files: Files, exclude_list: list, limit: int = 10, recent_enable: bool = False, prefix: str = ""):
+def get_recently_updated_files(existing_dates: dict, files: Files, exclude_list: list, limit: int = 10, recent_enable: bool = False, prefix: str = "", wpm: int = DEFAULT_WPM, wpm_cjk: int = DEFAULT_WPM_CJK):
     recently_updated_results = []
     if recent_enable:
         files_meta = []
@@ -252,7 +265,7 @@ def get_recently_updated_files(existing_dates: dict, files: Files, exclude_list:
                     cover = prefix + cover.lstrip('/')
                 # authors = file.page.meta.document_dates.authors
                 if file.page.file:
-                    summary, readtime = analyze_markdown(file.page.file.content_string)
+                    readtime, summary = analyze_markdown(file.page.file.content_string, wpm, wpm_cjk)
 
             meta_readtime = int((file.page.meta.get('readtime') or 0) if file.page else 0)
             readtime = meta_readtime if meta_readtime > 0 else readtime
@@ -350,9 +363,6 @@ def write_jsonl_cache(jsonl_file: Path, dates_cache, tracked_files):
 # - Supports mixed-language content (e.g. English + CJK)
 # ==================================================
 
-# ===== Extract Readtime =====
-DEFAULT_WPM = 240
-
 # Match Unicode "words" for space-delimited languages (English, Spanish, French, German, Russian, etc.)
 # CJK characters also match \w in Python, so they are removed before applying this regex to avoid double counting
 WORD_RE = re.compile(r"\w+", re.UNICODE)
@@ -424,7 +434,7 @@ BRACE_RE = re.compile(r"\{[^}]*\}")
 MD_SYNTAX_RE = re.compile(r"[`*_#]+")
 
 
-def analyze_markdown(md: str) -> list:
+def analyze_markdown(md: str, readtime_wpm: int = DEFAULT_WPM, readtime_wpm_cjk: int = DEFAULT_WPM_CJK) -> tuple[int, str]:
     # ---------- for Readtime ----------
     words = 0
     cjk = 0
@@ -590,15 +600,13 @@ def analyze_markdown(md: str) -> list:
     # ===============================
     # compute read time
     # ===============================
-    units = words + cjk / 2
-    seconds = math.ceil(units / DEFAULT_WPM * 60)
-
+    seconds = math.ceil((words / readtime_wpm + cjk / readtime_wpm_cjk) * 60)
     seconds += table_rows * 2
     seconds += code_rows
     seconds += math_blocks * 4
     seconds += images * 2
 
-    summary = MD_SYNTAX_RE.sub("", "  ".join(summary_lines)).strip()
     minutes = max(1, math.ceil(seconds / 60))
+    summary = MD_SYNTAX_RE.sub("", "  ".join(summary_lines)).strip()
 
-    return summary, minutes
+    return minutes, summary

{mkdocs_document_dates-3.8.5 → mkdocs_document_dates-3.8.7/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.8.5
+Version: 3.8.7
 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
@@ -102,7 +102,3 @@ Updates have been released that refactor and add a lot of new features, see http
 ## Chat Group
 
 **Discord**: https://discord.gg/cvTfge4AUy
-
-**Wechat**: 
-
-<img src="wechat-group.jpg" width="140" />

{mkdocs_document_dates-3.8.5 → mkdocs_document_dates-3.8.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mkdocs-document-dates"
-version = "3.8.5"
+version = "3.8.7"
 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"

{mkdocs_document_dates-3.8.5 → mkdocs_document_dates-3.8.7}/setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 def legacy_setup():
     setup(
         name="mkdocs-document-dates",
-        version="3.8.5",
+        version="3.8.7",
         author="Aaron Wang",
         author_email="aaronwqt@gmail.com",
         license="MIT",