add example of adding HTML tag to scribble output
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
No se nombra ningún archivo ni prueba. Empieza revisando el ejemplo de Scribble propuesto y las ubicaciones existentes de la documentación; después, elige ubicaciones y ejemplos adecuados que muestren la salida de etiquetas HTML y el anidamiento; se considerará terminado cuando se hayan completado ambas tareas enumeradas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I agree about the need for some kind of doc update. Outputting a specific HTML tag is a basic task and the answer is hard to find.
Maybe Scribble needs an FAQ, maybe we can get by with more indexing.
Originally posted by @bennn in https://github.com/racket/scribble/issues/233#issuecomment-636227679
tasks
- Choose suitable locations for examples
- choose suitable examples
Possible example (shows HTML tag nesting):
#lang scribble/base
@(require
(only-in scribble/core make-style)
(only-in scribble/html-properties alt-tag))
@(define details-style (make-style #f (list (alt-tag "details"))))
;summary
@(define summary-style (make-style #f (list (alt-tag "summary"))))
@(define (details summary . arg*)
(apply elem (elem summary #:style summary-style) #:style details-style arg*))
@; -----------------------------------------------------------------------------
This is a Scribble document with a @tt{details} element.
@details["the details heading"]{
The @tt{alt-tag} style property can change the HTML tag that
Scribble creates for an @tt{element} or @tt{paragraph}.
@url{https://docs.racket-lang.org/scribble/core.html#(def._((lib._scribble%2Fhtml-properties..rkt)._alt-tag))}
}
- Lenguaje dominante
- Racket
- Estrellas
- 251
- Forks
- 101
- Merge medio
- 11 d 9 h
- PR fusionados (30 d)
- 2
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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de racket/scribble
-
In source strcut*-doc does not convert to defstruct* properly when #:constructor-name is usedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de racket/scribble
Issues similares
-
Check Trellix Links...Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
NetAppDocs/ontap#2151 ·
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
nf-core/metaboigniter#132 ·
Los mantenedores suelen responder en 1 día
-
documentation hacktoberfest priority: low skill: good first issue status: ready for dev
Dificultad 2/5 Medio día Aptitud para principiantes 85/100
hyperledger-labs/fabric-smart-client#2142 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
netbox status: needs owner type: documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
netbox-community/netbox#23412 · 1 reacción ·
Los mantenedores suelen responder en 1 día