facebook / facebook/docusaurus

MDX loader: use resource query to partially import a file

Abierto
#6,480 7 comentarios 0 reacciones 0 asignados Ver en GitHub
domain: markdown 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#reporting-new-issues).

### Description

Currently, our blog plugin is able to truncate a post based on the `?truncated=true` resource query. E.g. `"modulePath": "blog/2018-12-14-Happy-First-Birthday-Slash.md?truncated=true"` Maybe we can implement something similar in the MDX loader itself.

### Has this been requested on Canny?

no

### Motivation

Allow partial imports instead of cutting a piece of Markdown out as partial

### API design

We could allow several types of queries:

- By file line number `?lines=3-9`. Prone to breaking when editing files but easy to implement and easy to reason about
- By heading ID `?section=caveats`. Less flexible, but still very easy to reason about
- By an arbitrary marker `?from=from&to=to`, and in the imported Markdown file, there are corresponding `` and `` markers. This may lead to broken syntax in some cases, but should still be fun to try

### Have you tried building it?

No

### Self-service

- [X] 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.