facebook / facebook/docusaurus

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

Ouverte
#5,691 24 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
domain: content plugin feature good first issue
Langage dominant
TypeScript
Étoiles
66.2k
Forks
10k
Merge moyen
1 j 3 h
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.