Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write dedicated page about the "HTML Runner" #1748

Closed
Krinkle opened this issue Aug 30, 2020 · 0 comments
Closed

Write dedicated page about the "HTML Runner" #1748

Krinkle opened this issue Aug 30, 2020 · 0 comments
Assignees
Labels
Category: Docs good first issue Straight-forward to start and receive help with.

Comments

@Krinkle
Copy link
Member

Krinkle commented Aug 30, 2020

There is a getting started guide that covers the basics for the Node and Browser use cases.

In qunitjs/qunitjs.com@0a70d75, I've added a dedicated page for the QUnit CLI with Node.

This ticket is to create a similar page for the Browser runner as well.

It could cover:

@Krinkle Krinkle added the good first issue Straight-forward to start and receive help with. label Sep 30, 2020
@Krinkle Krinkle self-assigned this Apr 1, 2022
@Krinkle Krinkle changed the title Write dedicated page about the "Browser runner" Write dedicated page about the "HTML Runner" Mar 29, 2024
@Krinkle Krinkle transferred this issue from qunitjs/qunitjs.com Mar 29, 2024
Krinkle added a commit that referenced this issue Jun 28, 2024
This restores the first half of the Cookbook that Jörn originally
wrote on the original qunitjs.com website. We removed this during the
redesign in 2020, but we hadn't found a new place for everything.

qunitjs/qunitjs.com#151
https://github.com/qunitjs/qunitjs.com/blob/v2.10.2/pages/cookbook.html

* Update config doc pages to reflect whether something is part of
  Browser Runner (active in any browser environment), or the
  HTML Reporter. These have been separated now per
  #1118, as QUnit.reporters.html,
  and deals purely with what happens inside the optional `div[id=qunit]`
  element.

* Move browser-related content from intro.md to the new browser.md.
  We should probably do the same for Node.js/CLI as well, and focus
  this only on env-agnostic getting started. This would be easier
  if the example use export/import ESM instead of having to assume
  either module.exports (Node.js) or globals (browser).

Co-authored-by: Jörn Zaefferer <joern.zaefferer@gmail.com>

Fixes #1748.
Fixes #1747.
Krinkle added a commit that referenced this issue Jun 28, 2024
This restores the first half of the Cookbook that Jörn originally
wrote on the original qunitjs.com website. We removed this during the
redesign in 2020, but we hadn't found a new place for everything.

qunitjs/qunitjs.com#151
https://github.com/qunitjs/qunitjs.com/blob/v2.10.2/pages/cookbook.html

* Update config doc pages to reflect whether something is part of
  Browser Runner (active in any browser environment), or the
  HTML Reporter. These have been separated now per
  #1118, as QUnit.reporters.html,
  and deals purely with what happens inside the optional `div[id=qunit]`
  element.

* Move browser-related content from intro.md to the new browser.md.
  We should probably do the same for Node.js/CLI as well, and focus
  this only on env-agnostic getting started. This would be easier
  if the example use export/import ESM instead of having to assume
  either module.exports (Node.js) or globals (browser).

Fixes #1748.
Fixes #1747.

Co-authored-by: Jörn Zaefferer <joern.zaefferer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Docs good first issue Straight-forward to start and receive help with.
Development

No branches or pull requests

1 participant