expressjs/expressjs.com

Res.Render documentation missing information.

Open

#1,457 opened on Jan 29, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CSS (2,088 forks)batch import
docshelp wanted

Repository metrics

Stars
 (5,330 stars)
PR merge metrics
 (Avg merge 11d) (31 merged PRs in 30d)

Description

I cannot find any information anywhere in the documentation or of other sources where res.render pulls the HTML from that we are referencing in the documentation.

For example, I want to render some HTML (preferably in a file somewhere) and inject some variables into it. In the photo below at docs we are stating 'email'.

image

  • Does this mean email.html in the same directory as this .js script?
  • Does this mean we previously read the file email.html and read it into memory somewhere?

I have been trying to understand this process of express and utilize this function but everyone just glances over this part in particular.

So. where is the html for email?

Contributor guide

Research direction
The issue requests clarification on how res.render works in Express documentation. The user is confused about where the template file (e.g., email.html) is located. The documentation at https://expressjs.com/en/api.html#app.render should be updated to explain that res.render uses the view engine and requires setting up a views directory. Refer to the Express guides on using view engines. No linked PRs or comments provide additional direction. The maintainer should provide a clear explanation and update the API docs accordingly.
Tech stack
javascriptnodejsexpress
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic Express usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70