Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Use standard markdown syntax for doccards

Abierto
  • ¿Algo no está bien?
#215 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
markdown, react, typescript
Área
documentation

Línea de trabajo

Comienza leyendo docUtils.js y el uso existente de DocCard y DocCardList en archivos .mdx; después, inspecciona cómo se integra remark en el pipeline de documentación. Compara las sintaxis propuestas para una sola tarjeta y para listas, incluido su comportamiento en archivos .md, y determina qué sintaxis debe admitirse antes de implementarla. La tarea estará terminada cuando Markdown puro pueda expresar doccards y la transformación de remark produzca los componentes esperados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

p:2

Currently, in order to use doccards you need to write a .mdx file, import and use DocCard or DocCardList react components along with our findSidebarItem in docUtils.js. This is quite some boilerplate code for oasis-core, oasis-sdk and other repositories which in general only include plain markdown files. Since there is no standard markdown syntax for doccards, we should still strive to use standard markdown so it is valid outside of docusaurus.

I suggest we use standard markdown syntax for doccards and then wrap it with actual components using remark as follows.

Single-line doccard:

@[doccard](../../some/file.md)

would be transformed into

<DocCard item={findSidebarItem("/general/some/file")} />

And for doccard list:

@doccardlist:

- ../../some/file1.md
- ../some/file2.md
- some/file3.md

would be transformed into:

<DocCardList items=[{
  findSidebarItem('/general/some/file1'),
  findSidebarItem('/general/network/some/file2'),
  findSidebarItem('/general/network/settings/some/file3'),
]} />

Potential issues:

  • if the doccard syntax above appears inside .md file (and not .mdx), will docusaurus want to compile <DocCardList> syntax inside "plain" .md file?
  • the @[doccard](some/link) will show doccard as text on the link. If there are multiple doccards one after another, that will be pretty nondescriptive

Alternatives:

  • Instead of using doccard literal, perhaps just placing @ in front of the link is sufficient? Or some other magic symbol, like ! or =? e.g. =[../../some/file.md]=
  • Maybe we could unify doccard and doccard list, so that if there is a single item, use doccard and for more items, doccardlist? Is there a way to set the number of doccards per row?
  • Check vuepress1&2, if they provide any better markdown syntax for doccards.
Lenguaje dominante
TypeScript
Estrellas
15
Forks
48
Merge medio
1 d 21 h
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de oasisprotocol/docs

Todos los issues de oasisprotocol/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.