azu / azu/gitbook-plugin-include-codeblock

Allow different types of escapes in template output

Abierto
#53 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
40
Forks
25
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

To allow exact code to be generated in different scenarios, we should provide different kinds of escapes for templates to choose. Here is a tentative list of escapes we need:

- HTML escape ( now available as ``{{tag}}`` )
- No escape ( now available as ``{{{tag}}}`` )
- Backslash escape (there are two variants: JS and commonmark).
JS string escape appears to be used in quotes inside Nunjucks tags (verification still to be done).
The most noted difference of the escapes are about whether to escape "\n".
AsciiDoctor appears to have backslash escape that "aren't very reliable" (words quoted from section 12.5 of Asciidoctor user manual). I guess commonmark escapes do well there.

- URI escape (for use in ``)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Empieza por localizar la gestión existente de la salida de plantillas que proporciona las formas actuales de HTML y sin escape. Verifica cómo se utiliza el escapado de cadenas de JavaScript dentro de las etiquetas de Nunjucks y, después, compara los comportamientos requeridos de JavaScript, CommonMark y URI. Se considera terminado cuando las plantillas pueden elegir cada modo de escape acordado y los casos documentados producen exactamente la salida esperada.

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

Evaluación

Stack tecnológico
javascript
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.