azu / azu/gitbook-plugin-include-codeblock

Allow different types of escapes in template output

Ouverte
#53 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
JavaScript
Étoiles
40
Forks
25
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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 ``)

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par localiser la gestion existante des sorties de template qui fournit les formes actuelles HTML et sans échappement. Vérifiez comment l’échappement des chaînes JavaScript est utilisé dans les balises Nunjucks, puis comparez les comportements requis pour JavaScript, CommonMark et URI. Le travail est considéré comme terminé lorsque les templates peuvent choisir chacun des modes d’échappement convenus et que les cas documentés produisent exactement la sortie attendue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.