mkdocs-document-dates 2.0.0__tar.gz → 2.1.8__tar.gz

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.1.8}/LICENSE

@@ -9,4 +9,3 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-[... 后续 MIT 许可证内容 ...]

mkdocs_document_dates-2.1.8/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: mkdocs-document-dates
+Version: 2.1.8
+Summary: An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents.
+Home-page: https://github.com/jaywhj/mkdocs-document-dates
+Author: Aaron Wang
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs>=1.0.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# mkdocs-document-dates
+
+English | [简体中文](README_zh.md)
+
+
+
+An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark> creation time, last modification time and author info of markdown documents.
+
+## Features
+
+- Work in any environment, for Git-less environments, CI/CD environments (e.g. GitHub Actions), one-person collaboration, multi-person collaboration, etc
+- Support for manually specifying time and author info in `Front Matter`
+- Support for multiple time formats (date, datetime, timeago)
+- Support for document exclusion mode
+- Flexible display position (top or bottom)
+- Elegant styling (fully customizable)
+- Supports Tooltip Hover Tips
+  - Intelligent repositioning to always float optimally in view
+  - Supports automatic theme switching following Material's light/dark color scheme
+  - Support for customizing themes, styles, animations
+  - Compatible with mouse, keyboard and **touch** (mobile) to trigger hover
+- Multi-language support, cross-platform support (Windows, macOS, Linux)
+
+## Showcases
+
+![render](render.gif)
+
+## Installation
+
+```bash
+pip install mkdocs-document-dates
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - document-dates
+```
+
+Or, personalize the configuration:
+
+```yaml
+plugins:
+  - document-dates:
+      position: top            # Display position: top (after title)  bottom (end of document), default: bottom
+      type: date               # Date type: date  datetime  timeago, default: date
+      locale: en               # Localization: zh zh_tw en es fr de ar ja ko ru, default: en
+      date_format: '%Y-%m-%d'  # Date format, Supports all Python datetime format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
+      time_format: '%H:%M:%S'  # Time format (valid only if type=datetime)
+      exclude:                 # List of excluded files
+        - temp.md              # Exclude specific file
+        - private/*            # Exclude all files in private directory, including subdirectories
+        - drafts/*.md          # Exclude all markdown files in the current directory drafts, but not subdirectories
+      
+      show_author: true        # Whether to display author: true false, default: true
+
+```
+
+## Specify time manually
+
+The plugin will automatically get the exact time of the document, will automatically cache the creation time, but of course, you can also specify it manually in `Front Matter`
+
+Priority: `Front Matter` > `Cache Files` > `File System Timestamps`
+
+```yaml
+---
+created: 2023-01-01
+modified: 2025-02-23
+---
+
+# Document Title
+```
+
+- `created` can be replaced with: `created, date, creation`
+- `modified` can be replaced with: `modified, updated, last_modified, last_updated`
+
+## Specify author manually
+
+The plugin will automatically get the author of the document, will parse the email and make a link, also you can specify it manually in `Front Matter`
+
+Priority: `Front Matter` > `Git Author Info` > `PC Username`
+
+```yaml
+---
+author: any-name
+email: e-name@gmail.com
+---
+
+# Document Title
+```
+
+- `author` can be replaced with: `author, name`
+- `email` can be replaced with: `email, mail`
+
+## Customization
+
+The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
+
+- Style & Theme: `docs/assets/document_dates/user.config.css`
+- Properties & Animations: `docs/assets/document_dates/user.config.js`
+- Localized languages: `docs/assets/document_dates/languages/` , refer to the template file `en.json` for any additions or modifications
+
+## Other Tips
+
+- In order to get the exact creation time, a separate cache file is used to store the creation time of the file, located in the doc folder (hidden by default), please don't delete it:
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it. In addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+
+<br />
+
+## Development Stories (Optional)
+
+A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
+
+- **Origin**:
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, then I don't understand why not read the file system time, but to use the git time, and raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+- **Iteration**:
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
+    - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
+    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+- **Difficulty**:
+    1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
+        - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific action occurs, such as every time commit is performed
+    2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
+        - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'
+- **Improve**:
+    - Since it has been re-developed, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity and personalization**
+        - Ease of use: don't let users do things manually if you can, e.g., auto-install Git Hooks, auto-cache, auto-commit, provide customized templates, etc
+        - Simplicity: no unnecessary configurations, the less the simpler, e.g. git account information, repo information, etc., are not required
+        - Personalization: almost everything can be customized, whether it's icons, styles, themes, or features, it's all fully customizable
+    - In addition, it has good compatibility and extensibility, and works well in WIN7, mobile devices, old Safari, etc
+- **The Last Secret**:
+    - I'm not a programmer, my main job is marketing, can you believe it? (Feel free to leave a comment)

mkdocs_document_dates-2.1.8/README.md

@@ -0,0 +1,137 @@
+# mkdocs-document-dates
+
+English | [简体中文](README_zh.md)
+
+
+
+An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark> creation time, last modification time and author info of markdown documents.
+
+## Features
+
+- Work in any environment, for Git-less environments, CI/CD environments (e.g. GitHub Actions), one-person collaboration, multi-person collaboration, etc
+- Support for manually specifying time and author info in `Front Matter`
+- Support for multiple time formats (date, datetime, timeago)
+- Support for document exclusion mode
+- Flexible display position (top or bottom)
+- Elegant styling (fully customizable)
+- Supports Tooltip Hover Tips
+  - Intelligent repositioning to always float optimally in view
+  - Supports automatic theme switching following Material's light/dark color scheme
+  - Support for customizing themes, styles, animations
+  - Compatible with mouse, keyboard and **touch** (mobile) to trigger hover
+- Multi-language support, cross-platform support (Windows, macOS, Linux)
+
+## Showcases
+
+![render](render.gif)
+
+## Installation
+
+```bash
+pip install mkdocs-document-dates
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - document-dates
+```
+
+Or, personalize the configuration:
+
+```yaml
+plugins:
+  - document-dates:
+      position: top            # Display position: top (after title)  bottom (end of document), default: bottom
+      type: date               # Date type: date  datetime  timeago, default: date
+      locale: en               # Localization: zh zh_tw en es fr de ar ja ko ru, default: en
+      date_format: '%Y-%m-%d'  # Date format, Supports all Python datetime format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
+      time_format: '%H:%M:%S'  # Time format (valid only if type=datetime)
+      exclude:                 # List of excluded files
+        - temp.md              # Exclude specific file
+        - private/*            # Exclude all files in private directory, including subdirectories
+        - drafts/*.md          # Exclude all markdown files in the current directory drafts, but not subdirectories
+      
+      show_author: true        # Whether to display author: true false, default: true
+
+```
+
+## Specify time manually
+
+The plugin will automatically get the exact time of the document, will automatically cache the creation time, but of course, you can also specify it manually in `Front Matter`
+
+Priority: `Front Matter` > `Cache Files` > `File System Timestamps`
+
+```yaml
+---
+created: 2023-01-01
+modified: 2025-02-23
+---
+
+# Document Title
+```
+
+- `created` can be replaced with: `created, date, creation`
+- `modified` can be replaced with: `modified, updated, last_modified, last_updated`
+
+## Specify author manually
+
+The plugin will automatically get the author of the document, will parse the email and make a link, also you can specify it manually in `Front Matter`
+
+Priority: `Front Matter` > `Git Author Info` > `PC Username`
+
+```yaml
+---
+author: any-name
+email: e-name@gmail.com
+---
+
+# Document Title
+```
+
+- `author` can be replaced with: `author, name`
+- `email` can be replaced with: `email, mail`
+
+## Customization
+
+The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
+
+- Style & Theme: `docs/assets/document_dates/user.config.css`
+- Properties & Animations: `docs/assets/document_dates/user.config.js`
+- Localized languages: `docs/assets/document_dates/languages/` , refer to the template file `en.json` for any additions or modifications
+
+## Other Tips
+
+- In order to get the exact creation time, a separate cache file is used to store the creation time of the file, located in the doc folder (hidden by default), please don't delete it:
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it. In addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+
+<br />
+
+## Development Stories (Optional)
+
+A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
+
+- **Origin**:
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, then I don't understand why not read the file system time, but to use the git time, and raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+- **Iteration**:
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
+    - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
+    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+- **Difficulty**:
+    1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
+        - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific action occurs, such as every time commit is performed
+    2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
+        - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'
+- **Improve**:
+    - Since it has been re-developed, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity and personalization**
+        - Ease of use: don't let users do things manually if you can, e.g., auto-install Git Hooks, auto-cache, auto-commit, provide customized templates, etc
+        - Simplicity: no unnecessary configurations, the less the simpler, e.g. git account information, repo information, etc., are not required
+        - Personalization: almost everything can be customized, whether it's icons, styles, themes, or features, it's all fully customizable
+    - In addition, it has good compatibility and extensibility, and works well in WIN7, mobile devices, old Safari, etc
+- **The Last Secret**:
+    - I'm not a programmer, my main job is marketing, can you believe it? (Feel free to leave a comment)

mkdocs_document_dates-2.1.8/mkdocs_document_dates/__init__.py

@@ -0,0 +1,6 @@
+"""MkDocs Document Dates Plugin."""
+
+from .hooks_installer import install
+
+# 在包被导入时自动执行 hooks 安装
+install()

mkdocs_document_dates-2.1.8/mkdocs_document_dates/cache_manager.py

@@ -0,0 +1,231 @@
+import os
+import sys
+import json
+import logging
+import platform
+import subprocess
+from datetime import datetime
+from pathlib import Path
+
+# 配置日志等级 (INFO WARNING ERROR)
+logging.basicConfig(
+    level=logging.WARNING,
+    format='%(levelname)s: %(message)s'
+)
+
+def find_mkdocs_projects():
+    try:
+        git_root = Path(subprocess.check_output(
+            ['git', 'rev-parse', '--show-toplevel'],
+            text=True, encoding='utf-8'
+        ).strip())
+
+        projects = []
+        # 遍历 git_root 及子目录, 寻找 mkdocs.yml 文件
+        for config_file in git_root.rglob('mkdocs.y*ml'):
+            if config_file.name.lower() in ('mkdocs.yml', 'mkdocs.yaml'):
+                projects.append(config_file.parent)
+
+        if not projects:
+            logging.info("No MkDocs projects found in the repository")
+        return projects
+    except subprocess.CalledProcessError as e:
+        logging.error(f"Failed to find the Git repository root: {e}")
+        return []
+    except Exception as e:
+        logging.error(f"Unexpected error while searching for MkDocs projects: {e}")
+        return []
+
+def get_file_creation_time(file_path):
+    try:
+        stat = os.stat(file_path)
+        system = platform.system().lower()
+        if system.startswith('win'):  # Windows
+            return datetime.fromtimestamp(stat.st_ctime)
+        elif system == 'darwin':  # macOS
+            try:
+                return datetime.fromtimestamp(stat.st_birthtime)
+            except AttributeError:
+                return datetime.fromtimestamp(stat.st_ctime)
+        else:  # Linux, 没有创建时间，使用修改时间
+            return datetime.fromtimestamp(stat.st_mtime)
+    except (OSError, ValueError) as e:
+        logging.error(f"Failed to get file creation time for {file_path}: {e}")
+        return datetime.now()
+
+def get_git_first_commit_time(file_path):
+    try:
+        # git log --reverse --format="%aI" --date=iso -- {file_path} | head -n 1
+        result = subprocess.run(['git', 'log', '--reverse', '--format=%aI', '--', file_path], capture_output=True, text=True)
+        if result.returncode == 0:
+            commits = result.stdout.strip().split('\n')
+            if commits and commits[0]:
+                return datetime.fromisoformat(commits[0]).replace(tzinfo=None)
+    except Exception as e:
+        logging.info(f"Error getting git first commit time for {file_path}: {e}")
+    return None
+
+def setup_gitattributes(docs_dir):
+    gitattributes_path = docs_dir / '.gitattributes'
+    union_config_line = ".dates_cache.jsonl merge=union"
+    updated = False
+    
+    if gitattributes_path.exists():
+        with open(gitattributes_path, 'r', encoding='utf-8') as f:
+            content = f.read()
+        
+        if union_config_line not in content:
+            with open(gitattributes_path, 'a', encoding='utf-8') as f:
+                f.write(f"\n{union_config_line}\n")
+            updated = True
+    else:
+        with open(gitattributes_path, 'w', encoding='utf-8') as f:
+            f.write(f"{union_config_line}\n")
+        updated = True
+    
+    if updated:
+        try:
+            subprocess.run(["git", "add", str(gitattributes_path)], check=True)
+            logging.info(f"Updated .gitattributes file: {gitattributes_path}")
+        except subprocess.CalledProcessError as e:
+            logging.error(f"Failed to add .gitattributes to git: {e}")
+    
+    return updated
+
+def read_json_cache(cache_file):
+    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:
+            logging.error(f"Failed to read existing JSON cache file: {e}")
+    return dates_cache
+
+def read_jsonl_cache(jsonl_file):
+    dates_cache = {}
+    if jsonl_file.exists():
+        try:
+            with open(jsonl_file, "r", encoding='utf-8') as f:
+                for line in f:
+                    try:
+                        entry = json.loads(line.strip())
+                        if entry and isinstance(entry, dict) and len(entry) == 1:
+                            file_path, file_info = next(iter(entry.items()))
+                            dates_cache[file_path] = file_info
+                    except (json.JSONDecodeError, StopIteration) as e:
+                        logging.warning(f"Skipping invalid JSONL line: {e}")
+        except IOError as e:
+            logging.error(f"Failed to read existing JSONL cache file: {e}")
+    return dates_cache
+
+def write_jsonl_cache(jsonl_file, dates_cache, tracked_files):
+    try:
+        # 使用临时文件写入，然后替换原文件，避免写入过程中的问题
+        temp_file = jsonl_file.with_suffix('.jsonl.tmp')
+        with open(temp_file, "w", encoding='utf-8') as f:
+            for file_path in tracked_files:
+                if file_path in dates_cache:
+                    entry = {file_path: dates_cache[file_path]}
+                    f.write(json.dumps(entry, ensure_ascii=False) + '\n')
+        
+        # 替换原文件
+        temp_file.replace(jsonl_file)
+        
+        # 将文件添加到git
+        subprocess.run(["git", "add", str(jsonl_file)], check=True)
+        logging.info(f"Successfully updated JSONL cache file: {jsonl_file}")
+        return True
+    except (IOError, json.JSONDecodeError) as e:
+        logging.error(f"Failed to write JSONL cache file {jsonl_file}: {e}")
+        return False
+    except subprocess.CalledProcessError as e:
+        logging.error(f"Failed to add JSONL cache file to git: {e}")
+        return False
+
+def update_cache():
+    global_updated = False
+    for project_dir in find_mkdocs_projects():
+        project_updated = False
+
+        docs_dir = project_dir / 'docs'
+        if not docs_dir.exists():
+            logging.error(f"Document directory does not exist: {docs_dir}")
+            continue
+
+        # 设置.gitattributes文件
+        gitattributes_updated = setup_gitattributes(docs_dir)
+        if gitattributes_updated:
+            global_updated = True
+
+        try:
+            # 获取docs目录下已跟踪(tracked)的markdown文件
+            cmd = ["git", "ls-files", "*.md"]
+            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True, check=True)
+            tracked_files = result.stdout.splitlines() if result.stdout else []
+            
+            if not tracked_files:
+                logging.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_cache_file = docs_dir / '.dates_cache.jsonl'
+            jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
+            
+            # 根据 git已跟踪的文件来更新
+            for file_path in tracked_files:
+                try:
+                    rel_path = file_path
+                    full_path = docs_dir / rel_path
+                    
+                    # 如果文件已在JSONL缓存中，跳过
+                    if rel_path in jsonl_dates_cache:
+                        continue
+                    
+                    # 处理新文件或迁移旧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():
+                        created_time = get_file_creation_time(full_path)
+                        if not jsonl_cache_file.exists() and not json_cache_file.exists():
+                            git_time = get_git_first_commit_time(full_path)
+                            if git_time is not None:
+                                created_time = min(created_time, git_time)
+                        jsonl_dates_cache[rel_path] = {
+                            "created": created_time.isoformat()
+                        }
+                        project_updated = True
+                except Exception as e:
+                    logging.error(f"Error processing file {file_path}: {e}")
+
+            # 标记删除不再跟踪的文件
+            files_to_remove = set(jsonl_dates_cache.keys()) - set(tracked_files)
+            if files_to_remove:
+                project_updated = True
+                logging.info(f"Removing {len(files_to_remove)} untracked files from cache")
+
+            # 如果有更新，写入JSONL缓存文件
+            if project_updated or not jsonl_cache_file.exists():
+                if write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files):
+                    global_updated = True
+            else:
+                logging.info(f"No updates needed for {jsonl_cache_file}")
+
+        except subprocess.CalledProcessError as e:
+            logging.error(f"Failed to execute git command: {e}")
+            continue
+    
+    return global_updated
+
+
+if __name__ == "__main__":
+    try:
+        update_cache()
+    except Exception as e:
+        logging.error(f"Hook execution failed: {e}")
+        sys.exit(1)

mkdocs_document_dates-2.1.8/mkdocs_document_dates/hooks/pre-commit

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+
+import sys
+import logging
+
+try:
+    from mkdocs_document_dates.cache_manager import update_cache
+except ImportError:
+    sys.exit(0)
+
+if __name__ == "__main__":
+    try:
+        update_cache()
+    except Exception as e:
+        logging.error(f"Hook execution failed: {e}")
+        sys.exit(1)