Skip to content

feat: 为文章页面添加作者和日期元信息展示 #81

Description

@ywh555hhh

考虑要求在其他地方标注一下本文作者,比如元数据部分

Originally posted by @ywh555hhh in #58

问题描述 (The Problem)

目前,我们的文档页面缺少一个标准化的、可见的方式来展示关键的元信息。读者无法直观地看到一篇文章的主要作者是谁,以及它的发布和最后更新日期。

这导致了两个问题:

  1. 缺乏内容背景: 读者难以判断文章的时效性和权威性。
  2. 信息不完整: 作为技术文档,作者和版本(更新)历史是重要的组成部分。

解决方案构想 (Proposed Solution)

我们建议在每篇文章的标题正下方,增加一个专门的元信息区域。

该区域应能灵活地展示以下信息:

  • 作者 (Author(s))
  • 发布日期 (Publish Date)
  • 最后更新日期 (Last Updated Date)

这将为所有文章提供一个统一、清晰的元信息展示标准。

技术方向与参考 (Technical Approach & References)

推荐的技术方案是利用 Material for MkDocs 的 主题扩展 (Theme Extension) 功能来实现,这可以确保我们的定制能够与主题的未来更新兼容。

具体思路是通过覆盖一个特定的模板文件来注入新的元信息块。

关键参考资料:

  1. 官方文档 - 扩展主题: 这是实现此功能的核心指南。

  2. 可能需要覆盖的目标模板: 渲染文章主体的模板是 partials/content.html,这是最可能需要修改的文件。

  3. 依赖项说明:

    • 为了自动获取“最后更新日期”,需要依赖 mkdocs-git-revision-date-localized-plugin 插件。

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions