facebook / facebook/docusaurus

Improve TypeScript Types for ThemeConfig

Abierto
#11,187 4 comentarios 0 reacciones 0 asignados Ver en GitHub
feature
Lenguaje dominante
TypeScript
Estrellas
66.2k
Forks
10k
Merge medio
1 d 3 h
PR fusionados (30 d)
52

Descripción

### Have you read the Contributing Guidelines on issues?

- [x] I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).

### Description

I would like to suggest providing better TypeScript types for `ThemeConfig` to improve the developer experience.

### Has this been requested on Canny?

_No response_

### Motivation

Currently, the `ThemeConfig` type is defined as:

```
export type ThemeConfig = {
[key: string]: unknown;
};
```

As a result, developers are unable to benefit from IDE IntelliSense when configuring `ThemeConfig` within `docusaurus.config.ts`.

Improving the type definition would greatly enhance the DX by enabling better autocompletion, error checking, and documentation directly within the editor.

### API design

_No response_

### Have you tried building it?

_No response_

### Self-service

- [ ] I'd be willing to contribute this feature to Docusaurus myself.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.