Docs should speak to the differences between html`` TTLs in other frameworks

Open
#100 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Search the documentation for guidance on html tagged template literals and read the surrounding examples, using the linked LitHTML comparison as context. Done when the docs explicitly contrast Enhance, which only requires the function's return value to be tagged, with LitHTML's requirement that concatenated strings be tagged.

Written by the indexing model from the issue text.

Description

docs

Enhance is not the first framework to construct DOM from an html tagged template literal. For example LitHTML also uses a TTL, and so some users may be familiar with using it. The difference between LitHTML and enhance is that LitHTML requires all the strings that you concat to be html. Enhance only requires the return value of the function to be tagged. It could eliminate some confusion if this were called out explicitly.

Dominant language
JavaScript
Stars
82
Forks
19
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from enhance-dev/enhance.dev

All issues in enhance-dev/enhance.dev

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.