Quicktips: Prefer Nunjucks comments over HTML ones
Nobody has claimed this yet.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 726
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 3
Description
Web Browser
All of them
Describe the bug
- Go to Quick Tip: Inline Minified JavaScript or Quick Tip: Super Simple CSS Concatenation.
- Copy the example code snippet.
- Run it with Eleventy
The HTML comments are carried over to the HTML output. Instead, it makes more sense to have them stripped by using {# … #} Nunjucks comments.
Files that would need editing under https://github.com/11ty/11ty-website/tree/main/src/docs/quicktips
Screenshots
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the files under src/docs/quicktips referenced by the two linked quick tips and inspect their example snippets. Compare the current HTML comments with the Nunjucks comment syntax in the linked Nunjucks documentation. Done means the examples use stripped comments and no longer carry those comments into generated HTML; run Eleventy to verify.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100