azu / azu/gitbook-plugin-include-codeblock

Allow different types of escapes in template output

Open
#53 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
40
Forks
25
PR merge metrics
No merged PRs in 30d

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the existing template-output handling that provides the current HTML and no-escape forms. Verify how JavaScript string escaping is used inside Nunjucks tags, then compare the required JavaScript, CommonMark, and URI behaviors. Done means templates can choose each agreed escape mode and the documented cases produce exact output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.