facebook / facebook/docusaurus

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

Open
#5,691 24 comments 0 reactions 0 assignees View on GitHub
domain: content plugin feature good first issue
Dominant language
TypeScript
Stars
66.2k
Forks
10k
Avg merge
1d 3h
Merged PRs (30d)
52

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](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues)?

Yes

### Has this been requested on [Canny](https://docusaurus.io/feature-requests)?

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:

```ts
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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.