facebook/Docusaurus

Last updated: feeding data through front matter, new "created" metadata

Open

#5,691 建立於 2021年10月12日

在 GitHub 查看
 (20 留言) (0 反應) (0 負責人)JavaScript (12,167 star) (1,074 fork)batch import
domain: content pluginfeaturegood first issuestatus: accepting pr

描述

🚀 Feature

Two things:

  • A new "created" metadata (using git history)
  • Allow manually feeding the "last updated" / "created" data in front matter when git history is not available / is messed up (e.g. #5598)

Have you read the Contributing Guidelines on issues?

Yes

Has this been requested on Canny?

Requested multiple times on Discord

Motivation

The "created" metadata can be used to differentiate between "new" pages and "deprecated" pages. "Last updated" shouldn't be entirely relying on git history since that can be buggy sometimes.

API Design

Front matter options:

last_update_time: Date | string
last_update_author: string
create_time: Date | string
create_author: string

New config options showCreateTime and showCreateAuthor

The implementation of "create time" shouldn't be too hard with git, but it can also be messed up in versioning, so🤷‍♂️ Front matter metadata FTW

Have you tried building it?

No

貢獻者指南

技術棧
javascripttypescriptreactnodejs
領域
documentationfull stack
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic understanding of DocusaurusFamiliarity with git history commands
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Review the proposed API design in the issue: front matter fields `last update time`, `last update author`, `create time`, `create author` and config options `showCreateTime` and `showCreateAuthor`. Investigate the existing last updated implementation in Docusaurus's plugin content docs to understand how git history is currently processed. Look at the source code for reading front matter and integrating git data, and consider how to add the 'created' metadata similarly. Check any linked comments or existing PRs for additional context.