Skip to content

docs: quickstart improvements#59

Open
cdebled wants to merge 2 commits into
lightpanda-io:mainfrom
cdebled:docs/quickstart-improvements
Open

docs: quickstart improvements#59
cdebled wants to merge 2 commits into
lightpanda-io:mainfrom
cdebled:docs/quickstart-improvements

Conversation

@cdebled
Copy link
Copy Markdown

@cdebled cdebled commented Apr 13, 2026

Summary

  • Use npm init -y with type=module in quickstart to avoid ES module errors
  • Add Windows WSL instructions and note in quickstart and installation pages

cdebled added 2 commits April 13, 2026 20:51
The default npm init uses commonjs which breaks the ESM import syntax
used in the example script. Switch to npm init -y and explicitly set
type=module, with a package.json snippet to confirm the setup.
cd hn-scraper && \
npm init
npm init -y && \
npm pkg set type=module
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively we could replace all .js extensions with .mjs which AFAIK run correctly w/ default nodejs config.

But idk what is the best practice TBH

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants