azu / azu/gitbook-plugin-include-codeblock

Allow different types of escapes in template output

Aperta
#53 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
40
Fork
25
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia individuando la gestione esistente dell’output dei template che fornisce le forme attuali HTML e senza escape. Verifica come viene utilizzato l’escaping delle stringhe JavaScript all’interno dei tag Nunjucks, quindi confronta i comportamenti richiesti di JavaScript, CommonMark e URI. Il lavoro è completo quando i template possono scegliere ciascuna modalità di escape concordata e i casi documentati producono esattamente l’output previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.