mkdocs-recently-updated-docs 1.4__py3-none-any.whl

mkdocs_recently_updated_docs/plugin.py

@@ -0,0 +1,50 @@
+from jinja2 import Environment, FileSystemLoader, select_autoescape
+from pathlib import Path
+from mkdocs.plugins import BasePlugin
+from mkdocs.config import config_options
+from mkdocs_document_dates.utils import load_git_last_updated_date, get_recently_updated_files
+
+
+class RecentlyUpdatedPlugin(BasePlugin):
+    config_scheme = (
+        ('limit', config_options.Type(int, default=10)),
+        ('exclude', config_options.Type(list, default=[]))
+    )
+
+    def __init__(self):
+        super().__init__()
+
+        self.recent_docs_html = None
+
+    def on_env(self, env, config, files):
+        limit = self.config.get('limit')
+        exclude_list = self.config.get('exclude')
+
+        docs_dir = Path(config['docs_dir'])
+        git_updated_dates = load_git_last_updated_date(docs_dir)
+        recently_updated_data = get_recently_updated_files(git_updated_dates, files, exclude_list, limit, True)
+
+        # 渲染HTML
+        self.recent_docs_html = self._render_recently_updated_html(recently_updated_data)
+
+        return env
+
+    def _render_recently_updated_html(self, recently_updated_data):
+        default_template_path = Path(__file__).parent / 'templates' / 'recently_updated_group.html'
+        template_dir = default_template_path.parent
+        template_file = default_template_path.name
+
+        # 加载模板
+        env = Environment(
+            loader = FileSystemLoader(str(template_dir)),
+            autoescape = select_autoescape(["html", "xml"])
+        )
+        template = env.get_template(template_file)
+
+        # 渲染模板
+        return template.render(recent_docs=recently_updated_data)
+
+    def on_post_page(self, output, page, config):
+        if '\n<!-- RECENTLY_UPDATED_DOCS -->' in output:
+            output = output.replace('\n<!-- RECENTLY_UPDATED_DOCS -->', self.recent_docs_html or '')
+        return output

mkdocs_recently_updated_docs/templates/recently_updated_group.html

@@ -0,0 +1,181 @@
+<style>
+.article-layout-switcher {
+    display: flex;
+    justify-content: flex-end;
+    margin-bottom: 12px;
+}
+.article-layout-switcher button + button {
+    margin-left: 8px;
+}
+.article-layout-switcher button {
+    background: transparent;
+    border: none;
+    cursor: pointer;
+    padding: 4px;
+    border-radius: 4px;
+    display: flex;
+    align-items: center;
+    color: var(--md-typeset-color, #1c1c1c);
+    opacity: 0.4;
+    transition: all 0.2s;
+}
+.article-layout-switcher button:hover {
+    background: rgba(142, 142, 142, 0.1);
+    opacity: 0.8;
+}
+.article-layout-switcher button.is-active {
+    opacity: 1;
+    color: var(--md-accent-fg-color, blue);
+    background: rgba(142, 142, 142, 0.1);
+}
+.article-layout-switcher .material-icons {
+    font-size: 20px;
+}
+
+/* --- 网格模式 (默认) --- */
+.article-grid {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: 20px;
+    margin: 20px 0;
+    /* transition: all 0.2s ease; */
+}
+
+/* --- 详情模式 (is-detail) --- */
+.article-grid.is-detail {
+    grid-template-columns: 1fr;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+/* --- 列表模式 (is-list) --- */
+.article-grid.is-list {
+    margin-left: auto;
+    margin-right: auto;
+
+    border: 1px solid rgba(142, 142, 142, 0.2);
+    border-radius: 8px;
+    row-gap: 0;
+    padding: 11px;
+}
+.article-grid.is-list .card-body {
+    display: none;
+}
+.article-grid.is-list .article-card {
+    border: none;
+    border-radius: 0;
+    padding: 8px;
+}
+.article-grid.is-list .card-title {
+    font-weight: 400;
+    color: #0077cc;
+    /* color: var(--md-typeset-color, #1c1c1c); */
+}
+.article-grid.is-list .card-date {
+    margin-right: 0;
+}
+
+
+.article-card {
+    border: 1px solid rgba(142, 142, 142, 0.2);
+    border-radius: 8px;
+    padding: 16px;
+    font-family: sans-serif;
+    box-sizing: border-box;
+    display: flex;
+    flex-direction: column;
+}
+
+/* --- 第一行：标题与时间 --- */
+.card-header {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    text-decoration: none;
+}
+.card-title {
+    font-weight: 700;
+    line-height: 1.4;
+    color: var(--md-typeset-color, #1c1c1c);
+    margin-right: 16px;
+}
+.card-date {
+    font-size: 0.84em;
+    color: rgba(100, 100, 100, 0.4);
+    white-space: nowrap;
+    margin-right: 10px;
+}
+.card-header:hover .card-title {
+    color: var(--md-accent-fg-color, blue);
+    text-decoration: underline;
+}
+
+/* --- 第二行：摘要与封面图 --- */
+.card-body {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    margin-top: 12px;
+}
+.card-summary {
+    flex: 1;
+    color: rgba(142, 142, 142, 1);
+    font-size: 0.7rem;
+    line-height: 1.6;
+    letter-spacing: 0.02rem;
+    word-break: break-all;
+    
+    /* 3 行文字截断，超出显示省略号 */
+    display: -webkit-box;
+    -webkit-box-orient: vertical;
+    -webkit-line-clamp: 3;
+    overflow: hidden;
+}
+.card-cover {
+    width: 120px;
+    height: 80px;
+    border-radius: 8px;
+    flex-shrink: 0;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    overflow: hidden;
+    margin-left: 10px;
+}
+.card-cover a {
+    display: block;
+    width: 100%;
+    height: 100%;
+}
+.card-cover img {
+    width: 100%;
+    height: 100%;
+    object-fit: cover;
+    margin: 0 !important;
+}
+</style>
+
+<div class="article-layout-switcher">
+    <button class="layout-list-btn" title="List View"><span class="material-icons">view_list</span></button>
+    <button class="layout-detail-btn" title="Detail View"><span class="material-icons">view_day</span></button>
+    <button class="layout-grid-btn" title="Grid View"><span class="material-icons">view_module</span></button>
+</div>
+
+<div class="article-grid">
+    {%- for mtime, rel_path, title, url, cover, summary in recent_docs %}
+    <div class="article-card">
+        <a class="card-header" href="{{ url }}" target="_blank">
+            <div class="card-title">{{ title }}</div>
+            <time class="dd-timeago card-date" datetime="{{ mtime }}">{{ mtime[:10] }}</time>
+        </a>
+        <div class="card-body">
+            <div class="card-summary">{{ summary }}</div>
+            {%- if cover %}
+            <div class="card-cover">
+                <img src="{{ cover }}" alt="{{ title }}">
+            </div>
+            {%- endif %}
+        </div>
+    </div>
+    {%- endfor %}
+</div>

mkdocs_recently_updated_docs-1.4.dist-info/METADATA

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: mkdocs-recently-updated-docs
+Version: 1.4
+Summary: A MkDocs plugin to show recently updated documents
+Author-email: Aaron Wang <aaronwqt@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/jaywhj/mkdocs-recently-updated-docs
+Project-URL: Documentation, https://jaywhj.netlify.app/document-dates-en
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs>=1.1.0
+Requires-Dist: mkdocs-document-dates>=3.5
+Dynamic: license-file
+
+# mkdocs-recently-updated-docs
+
+English | [简体中文](README_zh.md)
+
+<br />
+
+Display a list of recently updated documents anywhere on your MkDocs site with a single line of code. This is ideal for sites **with a large number of documents**, so that **readers can quickly see what's new**.
+
+## Features
+
+- Display recently updated documents in descending order by update time, list items are dynamically updated
+- Support multiple view modes such as list, detail and grid
+- Support automatic extraction of article summaries
+- Support custom display quantity
+- Support exclude specified files or folders
+- Works well for any environment (no-Git, Git, Docker, all CI/CD build systems, etc.)
+
+## Preview
+
+![recently-updated](recently-updated-en.gif)
+
+## Installation
+
+```bash
+pip install mkdocs-recently-updated-docs
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - recently-updated
+```
+
+Or, full configuration:
+
+```yaml
+plugins:
+  - recently-updated:
+      limit: 10          # Limit the number of docs displayed
+      exclude:           # List of excluded files
+        - index.md       # Exclude specific file
+        - blog/*         # Exclude all files in blog folder, including subfolders
+```
+
+## Usage
+
+Simply write this line anywhere in your md document:
+
+```markdown
+<!-- RECENTLY_UPDATED_DOCS -->
+```
+
+<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**](https://github.com/jaywhj/mkdocs-document-dates), a new generation MkDocs plugin for displaying exact **creation date, last updated date, authors, email** of documents
+
+  ![render](render.gif)
+
+<br />
+
+## Chat Group
+
+**Discord**: https://discord.gg/cvTfge4AUy
+
+**Wechat**: 
+
+<img src="wechat-group.jpg" width="140" />

mkdocs_recently_updated_docs-1.4.dist-info/RECORD

@@ -0,0 +1,9 @@
+mkdocs_recently_updated_docs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocs_recently_updated_docs/plugin.py,sha256=sVUr-f_nwSziuHWs2J98_C4EqiTAMni5CxP4j5XTaYk,1855
+mkdocs_recently_updated_docs/templates/recently_updated_group.html,sha256=dXCfhQ7BNQQKJKL64N1Bd4On8cMeKyK_RZCGFln3YDg,4381
+mkdocs_recently_updated_docs-1.4.dist-info/licenses/LICENSE,sha256=U214AUYxlWBRMcXtMCIHKPyd744Wc7YWu40eKZb8r68,1068
+mkdocs_recently_updated_docs-1.4.dist-info/METADATA,sha256=4zlzjpflGK8JhxBR2GuIiSi2Ll1lEoUsWL13f4B3FtA,2731
+mkdocs_recently_updated_docs-1.4.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+mkdocs_recently_updated_docs-1.4.dist-info/entry_points.txt,sha256=deX7xyDvYRa4SaqfZl0yPHCjMEkpjzn4hU4shOMlT_M,94
+mkdocs_recently_updated_docs-1.4.dist-info/top_level.txt,sha256=dAsrTPV8Yfy-0mkOcD6uASogl-WleHLrp1AiC4HV2n0,29
+mkdocs_recently_updated_docs-1.4.dist-info/RECORD,,

mkdocs_recently_updated_docs-1.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mkdocs_recently_updated_docs-1.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+recently-updated = mkdocs_recently_updated_docs.plugin:RecentlyUpdatedPlugin

mkdocs_recently_updated_docs-1.4.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Aaron Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

mkdocs_recently_updated_docs-1.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+mkdocs_recently_updated_docs