azu / azu/gitbook-plugin-include-codeblock
Allow different types of escapes in template output
- Vorherrschende Sprache
- JavaScript
- Sterne
- 40
- Forks
- 25
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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 ``)
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, die bestehende Verarbeitung von Template-Ausgaben zu finden, die die aktuellen HTML- und No-Escape-Formen bereitstellt. Überprüfe, wie das Escaping von JavaScript-Strings innerhalb von Nunjucks-Tags verwendet wird, und vergleiche anschließend das erforderliche Verhalten von JavaScript, CommonMark und URI. Als abgeschlossen gilt die Aufgabe, wenn Templates jeden vereinbarten Escape-Modus auswählen können und die dokumentierten Fälle eine exakt entsprechende Ausgabe erzeugen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100