facebook/Docusaurus

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

Open

#5691 opened on Oct 12, 2021

View on GitHub
 (20 comments) (0 reactions) (0 assignees)JavaScript (12,167 stars) (1,074 forks)batch import
domain: content pluginfeaturegood first issuestatus: accepting pr

Description

🚀 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

Contributor guide

Tech stack
javascripttypescriptreactnodejs
Domain
documentationfull stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of DocusaurusFamiliarity with git history commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.