:dfn[foo] should be presented in a way that allows for linking to them

Abierto
#7 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript

Línea de trabajo

Empieza revisando cómo se renderizan las definiciones :dfn y sus anclas; después, compara ese comportamiento con la presentación existente de header-link y con el ejemplo enlazado. Se considerará terminado cuando un lector pueda reconocer una definición y copiar o acceder a su enlace de ancla sin alterar el diseño actual de la spec.

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

Descripción

Currently, it is not possible to copy link to specific definition, even tho each have own anchor, and we link to them:

(example from https://github.com/ipfs/specs/pull/390)
2023-03-31_18-39

Quick ideas:

  • style :dfn[ so we can spot them? (dotted underline? Italic font? different weight?)
  • on :hover show <a> as # on the left (similar to how we already expose links to headers, but hide them by default)

cc @darobin @hacdias thoughts / ideas / examples how we could present this better?

Lenguaje dominante
JavaScript
Estrellas
4
Forks
2
Métricas de merge de PR
Sin PR fusionados en 30 d

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 ipfs/spec-generator

Todos los issues de ipfs/spec-generator

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.