mkdocs-document-dates 2.3.1__tar.gz → 2.3.2__tar.gz

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 2.3.1
+Version: 2.3.2
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -107,18 +107,18 @@ modified: 2025-02-23
 
 ## Notes
 
-- It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this in your .github/workflows/ci.yml:
-    
+- It still works when using CI/CD build systems (e.g. Github Actions), used a cache file `.dates_cache.json` to solve this problem:
+    1. First, you can configure the workflow like this (penultimate line) in your .github/workflows/ci.yml:
     ```
     ...
     
-      - run: pip install mkdocs-document-dates
-      - run: mkdocs gh-deploy --force
+        - run: pip install mkdocs-document-dates
+        - run: mkdocs gh-deploy --force
     ```
-  - Then update your Markdown files in MkDocs as normal, execute commands such as mkdocs build or directly git add, commit, and push
-    - Make sure you have installed python3 ahead of time and set environment variables
+    2. Then update your Markdown document in MkDocs as normal
+    3. After running git add and git commit, you will see the auto-generated cache file .dates_cache.json (hidden by default) in the `docs` folder under MkDocs
+        - Make sure you have installed python3 ahead of time and set environment variables
+    4. Finally, run git push, and you can see that there are also .dates_cache.json files in the docs directory in the GitHub repository, which means success
 - Priority of time reads:
-  - `Front Matter` > `Cache file` > `Filesystem timestamp`
+    - `Front Matter` > `Cache file` > `Filesystem timestamp`
 - If you are using MkDocs on a Linux system, the modification time is used as the creation time because of system limitations. If you need the exact creation time, you can specify it manually in Front Matter

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.2}/README.md

@@ -85,18 +85,18 @@ modified: 2025-02-23
 
 ## Notes
 
-- It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this in your .github/workflows/ci.yml:
-    
+- It still works when using CI/CD build systems (e.g. Github Actions), used a cache file `.dates_cache.json` to solve this problem:
+    1. First, you can configure the workflow like this (penultimate line) in your .github/workflows/ci.yml:
     ```
     ...
     
-      - run: pip install mkdocs-document-dates
-      - run: mkdocs gh-deploy --force
+        - run: pip install mkdocs-document-dates
+        - run: mkdocs gh-deploy --force
     ```
-  - Then update your Markdown files in MkDocs as normal, execute commands such as mkdocs build or directly git add, commit, and push
-    - Make sure you have installed python3 ahead of time and set environment variables
+    2. Then update your Markdown document in MkDocs as normal
+    3. After running git add and git commit, you will see the auto-generated cache file .dates_cache.json (hidden by default) in the `docs` folder under MkDocs
+        - Make sure you have installed python3 ahead of time and set environment variables
+    4. Finally, run git push, and you can see that there are also .dates_cache.json files in the docs directory in the GitHub repository, which means success
 - Priority of time reads:
-  - `Front Matter` > `Cache file` > `Filesystem timestamp`
+    - `Front Matter` > `Cache file` > `Filesystem timestamp`
 - If you are using MkDocs on a Linux system, the modification time is used as the creation time because of system limitations. If you need the exact creation time, you can specify it manually in Front Matter

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.2}/mkdocs_document_dates/plugin.py

@@ -51,9 +51,9 @@ class DocumentDatesPlugin(BasePlugin):
         return (
             f"<div class='document-dates-plugin-wrapper'>"
             f"<div class='document-dates-plugin'>"
-            f"<span title='{t['created_time']}'><span class='material-icons'>add_circle</span>"
+            f"<span title='{t['created_time']}: {created.strftime(self.config['date_format'])}'><span class='material-icons'>add_circle</span>"
             f"{self._get_formatted_date(created)}</span>"
-            f"<span title='{t['modified_time']}'><span class='material-icons'>update</span>"
+            f"<span title='{t['modified_time']}: {modified.strftime(self.config['date_format'])}'><span class='material-icons'>update</span>"
             f"{self._get_formatted_date(modified)}</span>"
             f"</div>"
             f"</div>"

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.2}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 2.3.1
+Version: 2.3.2
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -107,18 +107,18 @@ modified: 2025-02-23
 
 ## Notes
 
-- It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this in your .github/workflows/ci.yml:
-    
+- It still works when using CI/CD build systems (e.g. Github Actions), used a cache file `.dates_cache.json` to solve this problem:
+    1. First, you can configure the workflow like this (penultimate line) in your .github/workflows/ci.yml:
     ```
     ...
     
-      - run: pip install mkdocs-document-dates
-      - run: mkdocs gh-deploy --force
+        - run: pip install mkdocs-document-dates
+        - run: mkdocs gh-deploy --force
     ```
-  - Then update your Markdown files in MkDocs as normal, execute commands such as mkdocs build or directly git add, commit, and push
-    - Make sure you have installed python3 ahead of time and set environment variables
+    2. Then update your Markdown document in MkDocs as normal
+    3. After running git add and git commit, you will see the auto-generated cache file .dates_cache.json (hidden by default) in the `docs` folder under MkDocs
+        - Make sure you have installed python3 ahead of time and set environment variables
+    4. Finally, run git push, and you can see that there are also .dates_cache.json files in the docs directory in the GitHub repository, which means success
 - Priority of time reads:
-  - `Front Matter` > `Cache file` > `Filesystem timestamp`
+    - `Front Matter` > `Cache file` > `Filesystem timestamp`
 - If you are using MkDocs on a Linux system, the modification time is used as the creation time because of system limitations. If you need the exact creation time, you can specify it manually in Front Matter

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.2}/setup.py

@@ -7,7 +7,7 @@ try:
 except FileNotFoundError:
     long_description = "A MkDocs plugin for displaying accurate document creation and last modification dates."
 
-VERSION = '2.3.1'
+VERSION = '2.3.2'
 
 setup(
     name="mkdocs-document-dates",