-#### [Homepage](https://nightwatchjs.org) • [Getting Started](https://nightwatchjs.org/gettingstarted) • [Developer Guide](https://nightwatchjs.org/guide) • [API Reference](https://nightwatchjs.org/api) • [About](https://nightwatchjs.org/about)
+#### [Homepage](https://nightwatchjs.org) • [Developer Guide](https://nightwatchjs.org/guide) • [API Reference](https://nightwatchjs.org/api) • [About](https://nightwatchjs.org/about) • [Blog](https://nightwatchjs.org/blog)
***
+## Development
+
+The docs content is written in Markdown and it is located in the `docs` folder. The individual API command pages are generated from the Nightwatch source code. based on the JSDoc comments.
+
+### Run the website locally
+
+The website is built with **PostDoc** (a static site generator built with Vite and EJS). It supports Markdown, EJS, and front matter.
+It comes with a dev server with Hot module replacement (HMR).
+
+### Configuration
+
+The website configuration is located in the `postdoc.config.js` file. In order to run the website locally, you need to have the Nightwatch source code repo clones and then specify the path to it in the `postdoc.config.js` file.
+
+You can also set the `API_DOCS_FOLDER` environment variable to specify the path. You can also disable the API docs generation by setting the `apidocs` property to `false` in the `postdoc.config.js` file, e.g.:
+
+```js
+export default {
+ apidocs: false
+}
+```
+
+### Installation
+
+```bash
+npm install
+npm start
+```
+
+### PostDoc CLI
+
+To view the available options, run:
+
+```bash
+npx postdoc --help
+```
+
+#### Automatically open the website in the browser
+
+```bash
+npm start -- --open [chrome|firefox|edge|safari]
+```
+
+## Build
+
+To build the website, run:
+
+```bash
+npm run build
+```
+
+The generated files will be in the `out` folder.
+
+Quickly serve the generated files with:
+
+```bash
+npx postdoc preview
+```
+
+## License
+MIT
+
[discord-badge]: https://img.shields.io/discord/618399631038218240.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square
[discord]: https://discord.gg/SN8Da2X
diff --git a/build/optimize.js b/build/optimize.js
new file mode 100644
index 00000000..d5c28dae
--- /dev/null
+++ b/build/optimize.js
@@ -0,0 +1,54 @@
+import {generate} from 'critical';
+import {minify} from 'html-minifier';
+import {readFileSync, writeFileSync} from 'fs';
+import path from 'path';
+
+// Inline critical CSS
+generate({
+ inline: true,
+ base: 'out/',
+ src: 'index.html',
+ target: {
+ html: 'index.html',
+ uncritical: 'css/landing/style.css'
+ },
+ dimensions: [
+ {
+ height: 200,
+ width: 500
+ },
+ {
+ height: 900,
+ width: 1024
+ },
+ {
+ height: 900,
+ width: 1400
+ }
+ ],
+ // ignore CSS rules
+ ignoreInlinedStyles: true
+}).then(({css, html, uncritical}) => {
+ console.log('Critical CSS generated', css.length);
+ console.log('Uncritical CSS generated', uncritical.length);
+}).catch(err => {
+ console.error('Critical CSS generation failed', err);
+}).then(() => {
+ // Minify HTML
+ const htmlPath = path.resolve('out/index.html');
+ const htmlContent = readFileSync(htmlPath, 'utf8');
+ const minifiedHTMLContent = minify(htmlContent, {
+ collapseWhitespace: true,
+ collapseInlineTagWhitespace: true,
+ conservativeCollapse: true,
+ minifyCSS: true,
+ minifyJS: true,
+ removeComments: true,
+ useShortDoctype: true,
+ html5: true
+ });
+
+ writeFileSync(htmlPath, minifiedHTMLContent, 'utf8');
+ console.log('Wrote minified HTML to', htmlPath, minifiedHTMLContent.length);
+});
+
diff --git a/about/community/index.md b/docs/about/community/index.md
similarity index 100%
rename from about/community/index.md
rename to docs/about/community/index.md
diff --git a/about/contribute/index.md b/docs/about/contribute/index.md
similarity index 100%
rename from about/contribute/index.md
rename to docs/about/contribute/index.md
diff --git a/about/highlights/beyond-e2e.md b/docs/about/highlights/beyond-e2e.md
similarity index 100%
rename from about/highlights/beyond-e2e.md
rename to docs/about/highlights/beyond-e2e.md
diff --git a/about/highlights/developer-experience.md b/docs/about/highlights/developer-experience.md
similarity index 100%
rename from about/highlights/developer-experience.md
rename to docs/about/highlights/developer-experience.md
diff --git a/about/highlights/index.md b/docs/about/highlights/index.md
similarity index 100%
rename from about/highlights/index.md
rename to docs/about/highlights/index.md
diff --git a/about/highlights/types-of-testing.md b/docs/about/highlights/types-of-testing.md
similarity index 100%
rename from about/highlights/types-of-testing.md
rename to docs/about/highlights/types-of-testing.md
diff --git a/about/index.md b/docs/about/index.md
similarity index 100%
rename from about/index.md
rename to docs/about/index.md
diff --git a/api/alerts/index.md b/docs/api/alerts/index.md
similarity index 100%
rename from api/alerts/index.md
rename to docs/api/alerts/index.md
diff --git a/api/appium/index.md b/docs/api/appium/index.md
similarity index 100%
rename from api/appium/index.md
rename to docs/api/appium/index.md
diff --git a/api/assert/index.md b/docs/api/assert/index.md
similarity index 100%
rename from api/assert/index.md
rename to docs/api/assert/index.md
diff --git a/api/assertions.md b/docs/api/assertions.md
similarity index 100%
rename from api/assertions.md
rename to docs/api/assertions.md
diff --git a/api/chrome/index.md b/docs/api/chrome/index.md
similarity index 100%
rename from api/chrome/index.md
rename to docs/api/chrome/index.md
diff --git a/api/commands.md b/docs/api/commands.md
similarity index 100%
rename from api/commands.md
rename to docs/api/commands.md
diff --git a/api/commands/index.md b/docs/api/commands/index.md
similarity index 100%
rename from api/commands/index.md
rename to docs/api/commands/index.md
diff --git a/api/cookies/index.md b/docs/api/cookies/index.md
similarity index 100%
rename from api/cookies/index.md
rename to docs/api/cookies/index.md
diff --git a/api/document/index.md b/docs/api/document/index.md
similarity index 100%
rename from api/document/index.md
rename to docs/api/document/index.md
diff --git a/api/element.md b/docs/api/element.md
similarity index 100%
rename from api/element.md
rename to docs/api/element.md
diff --git a/api/element/index.md b/docs/api/element/index.md
similarity index 100%
rename from api/element/index.md
rename to docs/api/element/index.md
diff --git a/api/ensure.md b/docs/api/ensure.md
similarity index 100%
rename from api/ensure.md
rename to docs/api/ensure.md
diff --git a/api/ensure/index.md b/docs/api/ensure/index.md
similarity index 100%
rename from api/ensure/index.md
rename to docs/api/ensure/index.md
diff --git a/api/expect.md b/docs/api/expect.md
similarity index 100%
rename from api/expect.md
rename to docs/api/expect.md
diff --git a/api/expect/_cookie.md b/docs/api/expect/_cookie.md
similarity index 100%
rename from api/expect/_cookie.md
rename to docs/api/expect/_cookie.md
diff --git a/api/expect/_element.md b/docs/api/expect/_element.md
similarity index 100%
rename from api/expect/_element.md
rename to docs/api/expect/_element.md
diff --git a/api/expect/_elements.md b/docs/api/expect/_elements.md
similarity index 100%
rename from api/expect/_elements.md
rename to docs/api/expect/_elements.md
diff --git a/api/expect/_title.md b/docs/api/expect/_title.md
similarity index 100%
rename from api/expect/_title.md
rename to docs/api/expect/_title.md
diff --git a/api/expect/_url.md b/docs/api/expect/_url.md
similarity index 100%
rename from api/expect/_url.md
rename to docs/api/expect/_url.md
diff --git a/api/expect/element/index.md b/docs/api/expect/element/index.md
similarity index 100%
rename from api/expect/element/index.md
rename to docs/api/expect/element/index.md
diff --git a/api/expect/elements/index.md b/docs/api/expect/elements/index.md
similarity index 100%
rename from api/expect/elements/index.md
rename to docs/api/expect/elements/index.md
diff --git a/api/expect/index.md b/docs/api/expect/index.md
similarity index 100%
rename from api/expect/index.md
rename to docs/api/expect/index.md
diff --git a/api/firefox/index.md b/docs/api/firefox/index.md
similarity index 100%
rename from api/firefox/index.md
rename to docs/api/firefox/index.md
diff --git a/api/index.md b/docs/api/index.md
similarity index 100%
rename from api/index.md
rename to docs/api/index.md
diff --git a/api/method/clearValue.md b/docs/api/method/clearValue.md
similarity index 100%
rename from api/method/clearValue.md
rename to docs/api/method/clearValue.md
diff --git a/api/method/click.md b/docs/api/method/click.md
similarity index 100%
rename from api/method/click.md
rename to docs/api/method/click.md
diff --git a/api/method/end.md b/docs/api/method/end.md
similarity index 100%
rename from api/method/end.md
rename to docs/api/method/end.md
diff --git a/api/method/executeAsync.md b/docs/api/method/executeAsync.md
similarity index 100%
rename from api/method/executeAsync.md
rename to docs/api/method/executeAsync.md
diff --git a/api/page.md b/docs/api/page.md
similarity index 100%
rename from api/page.md
rename to docs/api/page.md
diff --git a/api/pageobject/index.md b/docs/api/pageobject/index.md
similarity index 100%
rename from api/pageobject/index.md
rename to docs/api/pageobject/index.md
diff --git a/api/programmatic.md b/docs/api/programmatic.md
similarity index 100%
rename from api/programmatic.md
rename to docs/api/programmatic.md
diff --git a/api/programmatic/index.md b/docs/api/programmatic/index.md
similarity index 100%
rename from api/programmatic/index.md
rename to docs/api/programmatic/index.md
diff --git a/api/useractions.md b/docs/api/useractions.md
similarity index 100%
rename from api/useractions.md
rename to docs/api/useractions.md
diff --git a/api/useractions/index.md b/docs/api/useractions/index.md
similarity index 100%
rename from api/useractions/index.md
rename to docs/api/useractions/index.md
diff --git a/api/window/index.md b/docs/api/window/index.md
similarity index 100%
rename from api/window/index.md
rename to docs/api/window/index.md
diff --git a/guide/browser-drivers/chromedriver.md b/docs/guide/browser-drivers/chromedriver.md
similarity index 100%
rename from guide/browser-drivers/chromedriver.md
rename to docs/guide/browser-drivers/chromedriver.md
diff --git a/guide/browser-drivers/edgedriver.md b/docs/guide/browser-drivers/edgedriver.md
similarity index 100%
rename from guide/browser-drivers/edgedriver.md
rename to docs/guide/browser-drivers/edgedriver.md
diff --git a/guide/browser-drivers/gecko-driver-firefox.md b/docs/guide/browser-drivers/gecko-driver-firefox.md
similarity index 100%
rename from guide/browser-drivers/gecko-driver-firefox.md
rename to docs/guide/browser-drivers/gecko-driver-firefox.md
diff --git a/guide/browser-drivers/geckodriver.md b/docs/guide/browser-drivers/geckodriver.md
similarity index 100%
rename from guide/browser-drivers/geckodriver.md
rename to docs/guide/browser-drivers/geckodriver.md
diff --git a/guide/browser-drivers/safaridriver.md b/docs/guide/browser-drivers/safaridriver.md
similarity index 100%
rename from guide/browser-drivers/safaridriver.md
rename to docs/guide/browser-drivers/safaridriver.md
diff --git a/guide/ci-integrations/run-nightwatch-on-azure-pipelines.md b/docs/guide/ci-integrations/run-nightwatch-on-azure-pipelines.md
similarity index 100%
rename from guide/ci-integrations/run-nightwatch-on-azure-pipelines.md
rename to docs/guide/ci-integrations/run-nightwatch-on-azure-pipelines.md
diff --git a/guide/ci-integrations/run-nightwatch-on-bamboo.md b/docs/guide/ci-integrations/run-nightwatch-on-bamboo.md
similarity index 100%
rename from guide/ci-integrations/run-nightwatch-on-bamboo.md
rename to docs/guide/ci-integrations/run-nightwatch-on-bamboo.md
diff --git a/guide/ci-integrations/run-nightwatch-on-circleci.md b/docs/guide/ci-integrations/run-nightwatch-on-circleci.md
similarity index 100%
rename from guide/ci-integrations/run-nightwatch-on-circleci.md
rename to docs/guide/ci-integrations/run-nightwatch-on-circleci.md
diff --git a/guide/ci-integrations/run-nightwatch-on-github-actions.md b/docs/guide/ci-integrations/run-nightwatch-on-github-actions.md
similarity index 100%
rename from guide/ci-integrations/run-nightwatch-on-github-actions.md
rename to docs/guide/ci-integrations/run-nightwatch-on-github-actions.md
diff --git a/guide/ci-integrations/run-nightwatch-on-gitlab.md b/docs/guide/ci-integrations/run-nightwatch-on-gitlab.md
similarity index 100%
rename from guide/ci-integrations/run-nightwatch-on-gitlab.md
rename to docs/guide/ci-integrations/run-nightwatch-on-gitlab.md
diff --git a/guide/ci-integrations/run-nightwatch-on-jenkins.md b/docs/guide/ci-integrations/run-nightwatch-on-jenkins.md
similarity index 100%
rename from guide/ci-integrations/run-nightwatch-on-jenkins.md
rename to docs/guide/ci-integrations/run-nightwatch-on-jenkins.md
diff --git a/guide/comparison-with-leading-frameworks.md b/docs/guide/comparison-with-leading-frameworks.md
similarity index 100%
rename from guide/comparison-with-leading-frameworks.md
rename to docs/guide/comparison-with-leading-frameworks.md
diff --git a/guide/component-testing/debugging.md b/docs/guide/component-testing/debugging.md
similarity index 100%
rename from guide/component-testing/debugging.md
rename to docs/guide/component-testing/debugging.md
diff --git a/guide/component-testing/introduction.md b/docs/guide/component-testing/introduction.md
similarity index 100%
rename from guide/component-testing/introduction.md
rename to docs/guide/component-testing/introduction.md
diff --git a/guide/component-testing/storybook-component-testing.md b/docs/guide/component-testing/storybook-component-testing.md
similarity index 100%
rename from guide/component-testing/storybook-component-testing.md
rename to docs/guide/component-testing/storybook-component-testing.md
diff --git a/guide/component-testing/testing-angular-components.md b/docs/guide/component-testing/testing-angular-components.md
similarity index 100%
rename from guide/component-testing/testing-angular-components.md
rename to docs/guide/component-testing/testing-angular-components.md
diff --git a/guide/component-testing/testing-react-components.md b/docs/guide/component-testing/testing-react-components.md
similarity index 100%
rename from guide/component-testing/testing-react-components.md
rename to docs/guide/component-testing/testing-react-components.md
diff --git a/guide/component-testing/testing-vue-components.md b/docs/guide/component-testing/testing-vue-components.md
similarity index 100%
rename from guide/component-testing/testing-vue-components.md
rename to docs/guide/component-testing/testing-vue-components.md
diff --git a/guide/component-testing/vite-plugin.md b/docs/guide/component-testing/vite-plugin.md
similarity index 100%
rename from guide/component-testing/vite-plugin.md
rename to docs/guide/component-testing/vite-plugin.md
diff --git a/guide/component-testing/write-jsx-react-tests.md b/docs/guide/component-testing/write-jsx-react-tests.md
similarity index 100%
rename from guide/component-testing/write-jsx-react-tests.md
rename to docs/guide/component-testing/write-jsx-react-tests.md
diff --git a/guide/concepts/component-testing.md b/docs/guide/concepts/component-testing.md
similarity index 100%
rename from guide/concepts/component-testing.md
rename to docs/guide/concepts/component-testing.md
diff --git a/guide/concepts/introduction-to-selenium-and-webdriver.md b/docs/guide/concepts/introduction-to-selenium-and-webdriver.md
similarity index 100%
rename from guide/concepts/introduction-to-selenium-and-webdriver.md
rename to docs/guide/concepts/introduction-to-selenium-and-webdriver.md
diff --git a/guide/concepts/page-object-model.md b/docs/guide/concepts/page-object-model.md
similarity index 94%
rename from guide/concepts/page-object-model.md
rename to docs/guide/concepts/page-object-model.md
index bfd45b4b..52b255c7 100644
--- a/guide/concepts/page-object-model.md
+++ b/docs/guide/concepts/page-object-model.md
@@ -89,9 +89,9 @@ Nightwatch will call the command on the context of the page or section. Client c
From Nightwatch 2 it is also possible to export the page commands as an ES6 class.
### Recommended content
-- [Define page elements](https://nightwatchjs.org/guide/using-page-objects/defining-elements.html)
-- [Define sections](https://nightwatchjs.org/guide/using-page-objects/defining-sections.html)
-- [Add page-specific commands](https://nightwatchjs.org/guide/using-page-objects/writing-page-specific-commands.html)
+- [Define page elements](/guide/using-page-objects/defining-elements.html)
+- [Define sections](/guide/using-page-objects/defining-sections.html)
+- [Add page-specific commands](/guide/using-page-objects/writing-page-specific-commands.html)
diff --git a/guide/concepts/parallel-testing-in-nightwatch.md b/docs/guide/concepts/parallel-testing-in-nightwatch.md
similarity index 89%
rename from guide/concepts/parallel-testing-in-nightwatch.md
rename to docs/guide/concepts/parallel-testing-in-nightwatch.md
index e6879c76..4a9b6ede 100644
--- a/guide/concepts/parallel-testing-in-nightwatch.md
+++ b/docs/guide/concepts/parallel-testing-in-nightwatch.md
@@ -27,8 +27,8 @@ It is very useful to be able to run your tests against multiple browsers in para
From **v1.7** you are able to do just that.
### Recommended content
-- [Define and use test environments](https://nightwatchjs.org/guide/configuration/define-test-environments.html)
-- [How-to guide > Run tests in parallel](https://nightwatchjs.org/guide/running-tests/parallel-running.html)
+- [Define and use test environments](/guide/configuration/define-test-environments.html)
+- [How-to guide > Run tests in parallel](/guide/running-tests/parallel-running.html)
diff --git a/guide/concepts/session-capabilities.md b/docs/guide/concepts/session-capabilities.md
similarity index 100%
rename from guide/concepts/session-capabilities.md
rename to docs/guide/concepts/session-capabilities.md
diff --git a/guide/concepts/test-environments.md b/docs/guide/concepts/test-environments.md
similarity index 100%
rename from guide/concepts/test-environments.md
rename to docs/guide/concepts/test-environments.md
diff --git a/guide/concepts/test-globals.md b/docs/guide/concepts/test-globals.md
similarity index 97%
rename from guide/concepts/test-globals.md
rename to docs/guide/concepts/test-globals.md
index 08f34b8e..5d4d1bc0 100644
--- a/guide/concepts/test-globals.md
+++ b/docs/guide/concepts/test-globals.md
@@ -207,8 +207,8 @@ myGlobalVar is: "integrated global"
```
### Recommended content
-- [Use external globals in tests](https://nightwatchjs.org/guide/writing-tests/using-test-globals.html)
-- [Use global test hooks in tests](https://nightwatchjs.org/guide/writing-tests/global-test-hooks.html)
+- [Use external globals in tests](/guide/writing-tests/using-test-globals.html)
+- [Use global test hooks in tests](/guide/writing-tests/global-test-hooks.html)
diff --git a/guide/concepts/what-is-end-to-end-testing.md b/docs/guide/concepts/what-is-end-to-end-testing.md
similarity index 100%
rename from guide/concepts/what-is-end-to-end-testing.md
rename to docs/guide/concepts/what-is-end-to-end-testing.md
diff --git a/guide/configuration/advanced-test-source-filtering.md b/docs/guide/configuration/advanced-test-source-filtering.md
similarity index 91%
rename from guide/configuration/advanced-test-source-filtering.md
rename to docs/guide/configuration/advanced-test-source-filtering.md
index ab0ad12d..1b6f940f 100644
--- a/guide/configuration/advanced-test-source-filtering.md
+++ b/docs/guide/configuration/advanced-test-source-filtering.md
@@ -56,8 +56,8 @@ The below settings can be used to define ways of filtering test files.
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/aws-devicefarm-settings.md b/docs/guide/configuration/aws-devicefarm-settings.md
similarity index 86%
rename from guide/configuration/aws-devicefarm-settings.md
rename to docs/guide/configuration/aws-devicefarm-settings.md
index f5de6731..5cbd66d4 100644
--- a/guide/configuration/aws-devicefarm-settings.md
+++ b/docs/guide/configuration/aws-devicefarm-settings.md
@@ -43,19 +43,19 @@ module.exports = (async function() {
// if this is not specified, the test source must be passed as the second argument to the test runner.
src_folders: [],
- // See https://nightwatchjs.org/guide/working-with-page-objects/using-page-objects.html
+ // See /guide/working-with-page-objects/using-page-objects.html
page_objects_path: ['node_modules/nightwatch/examples/pages/'],
- // See https://nightwatchjs.org/guide/extending-nightwatch/custom-commands.html
+ // See /guide/extending-nightwatch/custom-commands.html
custom_commands_path: ['node_modules/nightwatch/examples/custom-commands/'],
- // See https://nightwatchjs.org/guide/extending-nightwatch/custom-assertions.html
+ // See /guide/extending-nightwatch/custom-assertions.html
custom_assertions_path: '',
- // See https://nightwatchjs.org/guide/extending-nightwatch/plugin-api.html
+ // See /guide/extending-nightwatch/plugin-api.html
plugins: [],
- // See https://nightwatchjs.org/guide/#external-globals
+ // See /guide/#external-globals
globals_path : '',
webdriver: {},
@@ -102,8 +102,8 @@ module.exports = (async function() {
[1]: https://aws.amazon.com/device-farm/
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/browser-stack-settings.md b/docs/guide/configuration/browser-stack-settings.md
similarity index 95%
rename from guide/configuration/browser-stack-settings.md
rename to docs/guide/configuration/browser-stack-settings.md
index da7cd93e..72383db0 100644
--- a/guide/configuration/browser-stack-settings.md
+++ b/docs/guide/configuration/browser-stack-settings.md
@@ -124,8 +124,8 @@ You can specify proxy settings in Nightwatch by adding the `proxy` key in your `
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/customising-test-output.md b/docs/guide/configuration/customising-test-output.md
similarity index 94%
rename from guide/configuration/customising-test-output.md
rename to docs/guide/configuration/customising-test-output.md
index a72191cd..5d570b73 100644
--- a/guide/configuration/customising-test-output.md
+++ b/docs/guide/configuration/customising-test-output.md
@@ -90,8 +90,8 @@ The below settings can be used to control the output and logging when running te
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/define-test-environments.md b/docs/guide/configuration/define-test-environments.md
similarity index 95%
rename from guide/configuration/define-test-environments.md
rename to docs/guide/configuration/define-test-environments.md
index b541e49d..47eb0b69 100644
--- a/guide/configuration/define-test-environments.md
+++ b/docs/guide/configuration/define-test-environments.md
@@ -124,10 +124,10 @@ OK. 1 assertions passed. (5.604s)
```
### Recommended content
-- [Concepts > Test environments](https://nightwatchjs.org/guide/concepts/test-environments.html)
+- [Concepts > Test environments](/guide/concepts/test-environments.html)
- [Reference > Browser Drivers > ChormeDriver](/guide/configuration/define-test-environments.html)
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/enabling-http-keep-alive.md b/docs/guide/configuration/enabling-http-keep-alive.md
similarity index 100%
rename from guide/configuration/enabling-http-keep-alive.md
rename to docs/guide/configuration/enabling-http-keep-alive.md
diff --git a/guide/configuration/nightwatch-configuration-file.md b/docs/guide/configuration/nightwatch-configuration-file.md
similarity index 92%
rename from guide/configuration/nightwatch-configuration-file.md
rename to docs/guide/configuration/nightwatch-configuration-file.md
index ea584e5e..f555eb8c 100644
--- a/guide/configuration/nightwatch-configuration-file.md
+++ b/docs/guide/configuration/nightwatch-configuration-file.md
@@ -12,7 +12,7 @@ The Nightwatch test runner binary expects a configuration file located in the cu
- `nightwatch.conf.ts` (when using TypeScript)
- `nightwatch.json`
-You can always specify a config file location via the `--config` CLI argument. Read more about CLI options on the [Reference > Nightwatch CLI](https://nightwatchjs.org/guide/nightwatch-cli/command-line-options.html) page.
+You can always specify a config file location via the `--config` CLI argument. Read more about CLI options on the [Reference > Nightwatch CLI](/guide/nightwatch-cli/command-line-options.html) page.
From Nightwatch 2, you can also specify the config file to return a Promise and the result will be await-ed.
@@ -67,8 +67,8 @@ The following packages can be used from NPM and, if installed, Nightwatch will a
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/overview.md b/docs/guide/configuration/overview.md
similarity index 93%
rename from guide/configuration/overview.md
rename to docs/guide/configuration/overview.md
index e53a67c2..89626aa1 100644
--- a/guide/configuration/overview.md
+++ b/docs/guide/configuration/overview.md
@@ -104,7 +104,7 @@ Considering this setup, to run tests, for instance, against Safari, we would run
nightwatch --env safari
-Refer to the [Defining Test Environments](https://nightwatchjs.org/guide/using-nightwatch/concepts.html#defining-test-environments) page to learn more about how to use test environments.
+Refer to the [Defining Test Environments](/guide/using-nightwatch/concepts.html#defining-test-environments) page to learn more about how to use test environments.
### Working with Test Globals
Another useful concept that Nightwatch provides is test globals. In its most simple form, it is a dictionary of name-value pairs which is defined in your configuration file.
@@ -141,7 +141,7 @@ Like the `launch_url` property, the `globals` object is made available directly
};
-Refer to the [Using Test Globals](https://nightwatchjs.org/guide/using-nightwatch/concepts.html#using-test-globals) page to learn more about how to use test globals.
+Refer to the [Using Test Globals](/guide/using-nightwatch/concepts.html#using-test-globals) page to learn more about how to use test globals.
### Using Env variables
Any config value in either `nightwatch.conf.js` or `nightwatch.json` can be specified as the name of an environment variables. Nightwatch will automatically populate the value, if found, from `process.env`.
@@ -215,5 +215,5 @@ Assuming you have downloaded or installed the ChromeDriver service, the simplest
[4]: https://www.npmjs.com/package/selenium-server
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
\ No newline at end of file
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
\ No newline at end of file
diff --git a/guide/configuration/selenium-settings.md b/docs/guide/configuration/selenium-settings.md
similarity index 96%
rename from guide/configuration/selenium-settings.md
rename to docs/guide/configuration/selenium-settings.md
index 78e3cce3..a893c0aa 100644
--- a/guide/configuration/selenium-settings.md
+++ b/docs/guide/configuration/selenium-settings.md
@@ -146,8 +146,8 @@ The following **NPM** packages are assumed to be installed in the current projec
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/taking-screenshots-on-fail.md b/docs/guide/configuration/taking-screenshots-on-fail.md
similarity index 88%
rename from guide/configuration/taking-screenshots-on-fail.md
rename to docs/guide/configuration/taking-screenshots-on-fail.md
index bee82e50..48ea9f23 100644
--- a/guide/configuration/taking-screenshots-on-fail.md
+++ b/docs/guide/configuration/taking-screenshots-on-fail.md
@@ -27,8 +27,8 @@ To enable screenshots for test failures/errors, set the `screenshots` property i
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/using-env-variables-in-your-config.md b/docs/guide/configuration/using-env-variables-in-your-config.md
similarity index 91%
rename from guide/configuration/using-env-variables-in-your-config.md
rename to docs/guide/configuration/using-env-variables-in-your-config.md
index 403f6fac..089a2c4a 100644
--- a/guide/configuration/using-env-variables-in-your-config.md
+++ b/docs/guide/configuration/using-env-variables-in-your-config.md
@@ -44,8 +44,8 @@ Here's an example from the generated `nightwatch.conf.js`:
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/using-test-globals-in-your-config.md b/docs/guide/configuration/using-test-globals-in-your-config.md
similarity index 87%
rename from guide/configuration/using-test-globals-in-your-config.md
rename to docs/guide/configuration/using-test-globals-in-your-config.md
index ef2983b5..2f8f6880 100644
--- a/guide/configuration/using-test-globals-in-your-config.md
+++ b/docs/guide/configuration/using-test-globals-in-your-config.md
@@ -44,5 +44,5 @@ Like the `launch_url` property, the `globals` object is made available directly
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
\ No newline at end of file
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
\ No newline at end of file
diff --git a/guide/configuration/web-driver-settings.md b/docs/guide/configuration/web-driver-settings.md
similarity index 97%
rename from guide/configuration/web-driver-settings.md
rename to docs/guide/configuration/web-driver-settings.md
index f8d40999..78d9cb4b 100644
--- a/guide/configuration/web-driver-settings.md
+++ b/docs/guide/configuration/web-driver-settings.md
@@ -162,8 +162,8 @@ If you'd like to enable this, set `start_process` to `true` and specify the loca
### Recommended content
-- [Reference > All configuration settings](https://nightwatchjs.org/guide/reference/settings.html)
-- [Reference > Configuration defaults](https://nightwatchjs.org/guide/reference/defaults.html)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/contributing/codeofconduct.md b/docs/guide/contributing/codeofconduct.md
similarity index 96%
rename from guide/contributing/codeofconduct.md
rename to docs/guide/contributing/codeofconduct.md
index 0cc2bd6f..82736a29 100644
--- a/guide/contributing/codeofconduct.md
+++ b/docs/guide/contributing/codeofconduct.md
@@ -56,8 +56,8 @@ directly on top of `dev`.
For making changes to the documentation site, go to the `/guide` folder. Each section on the left
navigation pane is a separate folder. Use the following resources to learn about different on-page markdown elements and the style guide that we use.
-* [Markdown elements](https://nightwatchjs.org/guide/contributing/overview.html)
-* [Style guide](https://nightwatchjs.org/guide/contributing/styleguide.html)
+* [Markdown elements](/guide/contributing/overview.html)
+* [Style guide](/guide/contributing/styleguide.html)
### Step 4: Commit
diff --git a/guide/contributing/index.md b/docs/guide/contributing/index.md
similarity index 100%
rename from guide/contributing/index.md
rename to docs/guide/contributing/index.md
diff --git a/guide/contributing/styleguide.md b/docs/guide/contributing/styleguide.md
similarity index 100%
rename from guide/contributing/styleguide.md
rename to docs/guide/contributing/styleguide.md
diff --git a/guide/debugging-tests/overview.md b/docs/guide/debugging-tests/overview.md
similarity index 64%
rename from guide/debugging-tests/overview.md
rename to docs/guide/debugging-tests/overview.md
index 3715ee4f..41bbda9b 100644
--- a/guide/debugging-tests/overview.md
+++ b/docs/guide/debugging-tests/overview.md
@@ -11,17 +11,17 @@ Starting with v2.3.0, Nightwatch presents a more powerful test script debugging
#### Updated .pause() command
-The [`.pause()`](https://nightwatchjs.org/api/pause.html) command now provides the ability to resume paused tests on-demand while debugging. In addition, users can also step over to the next test step (execute the next test step) and pause again.
+The [`.pause()`](/api/pause.html) command now provides the ability to resume paused tests on-demand while debugging. In addition, users can also step over to the next test step (execute the next test step) and pause again.
#### New .debug() command
-The new [`.debug()`](https://nightwatchjs.org/api/debug.html) command provides a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) interface where users can try out any of the available Nightwatch commands or assertions and see them get executed in the running browser, in real-time.
+The new [`.debug()`](/api/debug.html) command provides a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) interface where users can try out any of the available Nightwatch commands or assertions and see them get executed in the running browser, in real-time.
### Recommended content
-- [API docs > `.pause()`](https://nightwatchjs.org/api/pause.html)
-- [API docs > `.debug()`](https://nightwatchjs.org/api/debug.html)
+- [API docs > `.pause()`](/api/pause.html)
+- [API docs > `.debug()`](/api/debug.html)
diff --git a/guide/debugging-tests/using-debug.md b/docs/guide/debugging-tests/using-debug.md
similarity index 84%
rename from guide/debugging-tests/using-debug.md
rename to docs/guide/debugging-tests/using-debug.md
index d0a5bcd3..1e2162f6 100644
--- a/guide/debugging-tests/using-debug.md
+++ b/docs/guide/debugging-tests/using-debug.md
@@ -7,7 +7,7 @@ description: Learn how to pause your test at specific points and debug by access
### Overview
-This is a new command added in Nightwatch v2.3.0, which allows users to pause the test at any point (by using [`.debug()`](https://nightwatchjs.org/api/debug.html) command as a breakpoint) and use a REPL interface (made available in the terminal) to try out the available Nightwatch commands and assertions and see them get executed against the running browser, in real-time.
+This is a new command added in Nightwatch v2.3.0, which allows users to pause the test at any point (by using [`.debug()`](/api/debug.html) command as a breakpoint) and use a REPL interface (made available in the terminal) to try out the available Nightwatch commands and assertions and see them get executed against the running browser, in real-time.
While doing that, users can also interact with the browser and use DevTools to debug. The interface also supports multi-line code input and auto-complete feature.
@@ -49,8 +49,8 @@ While doing that, users can also interact with the browser and use DevTools to d
### Recommended content
-- [API docs > `.pause()`](https://nightwatchjs.org/api/pause.html)
-- [API docs > `.debug()`](https://nightwatchjs.org/api/debug.html)
+- [API docs > `.pause()`](/api/pause.html)
+- [API docs > `.debug()`](/api/debug.html)
diff --git a/guide/debugging-tests/using-pause.md b/docs/guide/debugging-tests/using-pause.md
similarity index 86%
rename from guide/debugging-tests/using-pause.md
rename to docs/guide/debugging-tests/using-pause.md
index 79193b69..639627cf 100644
--- a/guide/debugging-tests/using-pause.md
+++ b/docs/guide/debugging-tests/using-pause.md
@@ -7,7 +7,7 @@ description: Learn how to pause your test at specific points to debug the test
### Overview
-The [`.pause()`](https://nightwatchjs.org/api/pause.html) command allows users to pause their test execution, either for a fixed amount of time (by passing the duration in milliseconds as an argument) or for an unrestricted amount of time with an option to resume anytime.
+The [`.pause()`](/api/pause.html) command allows users to pause their test execution, either for a fixed amount of time (by passing the duration in milliseconds as an argument) or for an unrestricted amount of time with an option to resume anytime.
To suspend the text execution for a limited amount of time (e.g. 300ms), write:
@@ -55,8 +55,8 @@ While using the `pause()` command without any argument, the following operations
### Recommended content
-- [API docs > `.pause()`](https://nightwatchjs.org/api/pause.html)
-- [API docs > `.debug()`](https://nightwatchjs.org/api/debug.html)
+- [API docs > `.pause()`](/api/pause.html)
+- [API docs > `.debug()`](/api/debug.html)
diff --git a/guide/extending-nightwatch/adding-custom-assertions.md b/docs/guide/extending-nightwatch/adding-custom-assertions.md
similarity index 97%
rename from guide/extending-nightwatch/adding-custom-assertions.md
rename to docs/guide/extending-nightwatch/adding-custom-assertions.md
index f03b457a..560a0376 100644
--- a/guide/extending-nightwatch/adding-custom-assertions.md
+++ b/docs/guide/extending-nightwatch/adding-custom-assertions.md
@@ -124,7 +124,7 @@ Assertions implement a simple interface which is shared between built-in asserti
};
diff --git a/guide/extending-nightwatch/adding-custom-commands.md b/docs/guide/extending-nightwatch/adding-custom-commands.md
similarity index 98%
rename from guide/extending-nightwatch/adding-custom-commands.md
rename to docs/guide/extending-nightwatch/adding-custom-commands.md
index 394ac871..8f7380fc 100644
--- a/guide/extending-nightwatch/adding-custom-commands.md
+++ b/docs/guide/extending-nightwatch/adding-custom-commands.md
@@ -260,7 +260,7 @@ You can also use ES6 `async`/`await` syntax inside function-style custom command
diff --git a/guide/extending-nightwatch/adding-custom-reporters.md b/docs/guide/extending-nightwatch/adding-custom-reporters.md
similarity index 95%
rename from guide/extending-nightwatch/adding-custom-reporters.md
rename to docs/guide/extending-nightwatch/adding-custom-reporters.md
index 03b49392..8962a8ee 100644
--- a/guide/extending-nightwatch/adding-custom-reporters.md
+++ b/docs/guide/extending-nightwatch/adding-custom-reporters.md
@@ -22,7 +22,7 @@ Define your reporter in a separate file, using the below interface, and then spe
### via external globals
-Add your reporter in the external globals file. Read more about [external globals](https://nightwatchjs.org/guide/concepts/test-globals.html).
+Add your reporter in the external globals file. Read more about [external globals](/guide/concepts/test-globals.html).
See the provided [globalsModule.js](https://github.com/nightwatchjs/nightwatch/blob/main/examples/globalsModule.js) for an example.
diff --git a/guide/extending-nightwatch/adding-plugins.md b/docs/guide/extending-nightwatch/adding-plugins.md
similarity index 100%
rename from guide/extending-nightwatch/adding-plugins.md
rename to docs/guide/extending-nightwatch/adding-plugins.md
diff --git a/guide/how-to-guides/index.md b/docs/guide/how-to-guides/index.md
similarity index 100%
rename from guide/how-to-guides/index.md
rename to docs/guide/how-to-guides/index.md
diff --git a/guide/index.md b/docs/guide/index.md
similarity index 100%
rename from guide/index.md
rename to docs/guide/index.md
diff --git a/guide/migrating-to-nightwatch/folder_changes.png b/docs/guide/migrating-to-nightwatch/folder_changes.png
similarity index 100%
rename from guide/migrating-to-nightwatch/folder_changes.png
rename to docs/guide/migrating-to-nightwatch/folder_changes.png
diff --git a/guide/migrating-to-nightwatch/from-nightwatch-v1.md b/docs/guide/migrating-to-nightwatch/from-nightwatch-v1.md
similarity index 100%
rename from guide/migrating-to-nightwatch/from-nightwatch-v1.md
rename to docs/guide/migrating-to-nightwatch/from-nightwatch-v1.md
diff --git a/guide/migrating-to-nightwatch/from-protractor.md b/docs/guide/migrating-to-nightwatch/from-protractor.md
similarity index 94%
rename from guide/migrating-to-nightwatch/from-protractor.md
rename to docs/guide/migrating-to-nightwatch/from-protractor.md
index 1ccdd428..1dbdb98c 100644
--- a/guide/migrating-to-nightwatch/from-protractor.md
+++ b/docs/guide/migrating-to-nightwatch/from-protractor.md
@@ -41,7 +41,7 @@ You will see these changes in your project, after you had run schematics on your
1. Now, You need to modify your existing tests to Nightwatch. To being with you can start with [Assertions][AssertionLink], [Expect][ExceptLink], [Page Objects][PageObjectLink] and [API commands][APICommandsLink].
-2. We had added few examples in this guide, but if you need more information please visit: https://nightwatchjs.org/api/
+2. We had added few examples in this guide, but if you need more information please visit: /api/
> Check out our [Nightwatch Schematic documentation][NightwatchSchematicDocumentation] for more details like running tests in a specific browser, etc.
@@ -135,7 +135,7 @@ browser
})
```
-> You can learn more about working with DOM elements in our [official documentation](https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html)
+> You can learn more about working with DOM elements in our [official documentation](/guide/writing-tests/finding-interacting-with-dom-elements.html)
### Assertions
@@ -266,10 +266,10 @@ The best way to ask for questions or report issues related to Nightwatch Angular
[AngualarRFC]:https://github.com/angular/protractor/issues/5502
[NightwatchSchematicDocumentation]:https://github.com/nightwatchjs/nightwatch-schematics#readme
[GithubIssueLink]:https://github.com/nightwatchjs/nightwatch-schematics/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
-[AssertionLink]:https://nightwatchjs.org/api/assert/
-[ExceptLink]:https://nightwatchjs.org/api/expect/
-[PageObjectLink]:https://nightwatchjs.org/api/pageobject/
-[APICommandsLink]:https://nightwatchjs.org/api/commands/
+[AssertionLink]:/api/assert/
+[ExceptLink]:/api/expect/
+[PageObjectLink]:/api/pageobject/
+[APICommandsLink]:/api/commands/
diff --git a/guide/mobile-app-testing/assertions.md b/docs/guide/mobile-app-testing/assertions.md
similarity index 100%
rename from guide/mobile-app-testing/assertions.md
rename to docs/guide/mobile-app-testing/assertions.md
diff --git a/guide/mobile-app-testing/commands.md b/docs/guide/mobile-app-testing/commands.md
similarity index 100%
rename from guide/mobile-app-testing/commands.md
rename to docs/guide/mobile-app-testing/commands.md
diff --git a/guide/mobile-app-testing/debug-tests.md b/docs/guide/mobile-app-testing/debug-tests.md
similarity index 100%
rename from guide/mobile-app-testing/debug-tests.md
rename to docs/guide/mobile-app-testing/debug-tests.md
diff --git a/guide/mobile-app-testing/installation.md b/docs/guide/mobile-app-testing/installation.md
similarity index 100%
rename from guide/mobile-app-testing/installation.md
rename to docs/guide/mobile-app-testing/installation.md
diff --git a/guide/mobile-app-testing/introduction-writing-tests.md b/docs/guide/mobile-app-testing/introduction-writing-tests.md
similarity index 100%
rename from guide/mobile-app-testing/introduction-writing-tests.md
rename to docs/guide/mobile-app-testing/introduction-writing-tests.md
diff --git a/guide/mobile-app-testing/introduction.md b/docs/guide/mobile-app-testing/introduction.md
similarity index 100%
rename from guide/mobile-app-testing/introduction.md
rename to docs/guide/mobile-app-testing/introduction.md
diff --git a/guide/mobile-app-testing/running-tests.md b/docs/guide/mobile-app-testing/running-tests.md
similarity index 100%
rename from guide/mobile-app-testing/running-tests.md
rename to docs/guide/mobile-app-testing/running-tests.md
diff --git a/guide/mobile-app-testing/selectors.md b/docs/guide/mobile-app-testing/selectors.md
similarity index 96%
rename from guide/mobile-app-testing/selectors.md
rename to docs/guide/mobile-app-testing/selectors.md
index 8c0bf573..8172a3c1 100644
--- a/guide/mobile-app-testing/selectors.md
+++ b/docs/guide/mobile-app-testing/selectors.md
@@ -46,7 +46,7 @@ Now that you understand selectors, you can use them to write commands & assertio
[1]: https://appium.io/docs/en/commands/element/find-elements/index.html#selector-strategies
-[2]: https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html#element-properties
+[2]: /guide/writing-tests/finding-interacting-with-dom-elements.html#element-properties
[3]: /guide/mobile-app-testing/commands.html
[4]: /guide/mobile-app-testing/assertions.html
diff --git a/guide/mobile-web-testing/override-device-dimensions.md b/docs/guide/mobile-web-testing/override-device-dimensions.md
similarity index 100%
rename from guide/mobile-web-testing/override-device-dimensions.md
rename to docs/guide/mobile-web-testing/override-device-dimensions.md
diff --git a/guide/mobile-web-testing/with-appium.md b/docs/guide/mobile-web-testing/with-appium.md
similarity index 95%
rename from guide/mobile-web-testing/with-appium.md
rename to docs/guide/mobile-web-testing/with-appium.md
index b5cacb3c..21f83832 100644
--- a/guide/mobile-web-testing/with-appium.md
+++ b/docs/guide/mobile-web-testing/with-appium.md
@@ -87,7 +87,7 @@ These APIs are platform specific. You can refer more on this on [Appium docs](ht
##### 2) Using the Actions API
-The [Actions API](https://nightwatchjs.org/api/useractions/) is very general and platform independent. It relies on the concept of input sources (key, pointer, wheel). Following code generates a swipe and a pinch zoom gesture using Actions API:
+The [Actions API](/api/useractions/) is very general and platform independent. It relies on the concept of input sources (key, pointer, wheel). Following code generates a swipe and a pinch zoom gesture using Actions API:
tests/sampleTest.js
describe('W3C Actions API', function() {
it('swipe down and zoom in the page - w3c actions api ', async function(){
diff --git a/guide/network-requests/capture-network-calls.md b/docs/guide/network-requests/capture-network-calls.md
similarity index 98%
rename from guide/network-requests/capture-network-calls.md
rename to docs/guide/network-requests/capture-network-calls.md
index cb0cd001..88ff6d34 100644
--- a/guide/network-requests/capture-network-calls.md
+++ b/docs/guide/network-requests/capture-network-calls.md
@@ -98,7 +98,7 @@ Request headers: {
### Recommended content
- [Chrome DevTools Protocol in Selenium 4](https://www.selenium.dev/documentation/webdriver/bidirectional/chrome_devtools/)
-- [Intercept network responses](https://nightwatchjs.org/guide/network-requests/mock-network-response.html)
+- [Intercept network responses](/guide/network-requests/mock-network-response.html)
diff --git a/guide/network-requests/mock-geolocation.md b/docs/guide/network-requests/mock-geolocation.md
similarity index 100%
rename from guide/network-requests/mock-geolocation.md
rename to docs/guide/network-requests/mock-geolocation.md
diff --git a/guide/network-requests/mock-network-response.md b/docs/guide/network-requests/mock-network-response.md
similarity index 97%
rename from guide/network-requests/mock-network-response.md
rename to docs/guide/network-requests/mock-network-response.md
index d79d65b5..abfa8958 100644
--- a/guide/network-requests/mock-network-response.md
+++ b/docs/guide/network-requests/mock-network-response.md
@@ -77,7 +77,7 @@ All you need to do is call the `browser.mockNetworkResponse()` command with the
### Recommended content
- [Chrome DevTools Protocol in Selenium 4](https://www.selenium.dev/documentation/webdriver/bidirectional/chrome_devtools/)
-- [Capture network requests](https://nightwatchjs.org/guide/network-requests/capture-network-calls.html)
+- [Capture network requests](/guide/network-requests/capture-network-calls.html)
diff --git a/guide/nightwatch-cli/command-line-options.md b/docs/guide/nightwatch-cli/command-line-options.md
similarity index 96%
rename from guide/nightwatch-cli/command-line-options.md
rename to docs/guide/nightwatch-cli/command-line-options.md
index 4aba0312..d04f69ad 100644
--- a/guide/nightwatch-cli/command-line-options.md
+++ b/docs/guide/nightwatch-cli/command-line-options.md
@@ -215,9 +215,9 @@ write(results, options, done) {
diff --git a/guide/overview/what-is-nightwatch.md b/docs/guide/overview/what-is-nightwatch.md
similarity index 100%
rename from guide/overview/what-is-nightwatch.md
rename to docs/guide/overview/what-is-nightwatch.md
diff --git a/guide/overview/what-is-webdriver.md b/docs/guide/overview/what-is-webdriver.md
similarity index 95%
rename from guide/overview/what-is-webdriver.md
rename to docs/guide/overview/what-is-webdriver.md
index 195b1087..09e8ca35 100644
--- a/guide/overview/what-is-webdriver.md
+++ b/docs/guide/overview/what-is-webdriver.md
@@ -29,7 +29,7 @@ description: Webdriver is a general purpose library for automating web browsers
[image-2]: /img/operation-cloud.png
### Recommended content
-- [Nightwatch release notes](https://nightwatchjs.org/guide/overview/whats-new.html)
+- [Nightwatch release notes](/guide/overview/whats-new.html)
- [Selenium WebDriver Docs](https://www.selenium.dev/documentation/webdriver/)
- [WebDriver Docs on MDN](https://developer.mozilla.org/en-US/docs/Web/WebDriver)
- [W3C WebDriver spec](https://www.w3.org/TR/webdriver1/)
diff --git a/guide/overview/whats-new-in-v2.md b/docs/guide/overview/whats-new-in-v2.md
similarity index 91%
rename from guide/overview/whats-new-in-v2.md
rename to docs/guide/overview/whats-new-in-v2.md
index 75a700e3..e53def69 100644
--- a/guide/overview/whats-new-in-v2.md
+++ b/docs/guide/overview/whats-new-in-v2.md
@@ -17,11 +17,11 @@ Since Nightwatch v2 builds on top of [Selenium](https://www.selenium.dev/) now,
- ##### [New user actions API](/api/useractions/)
Nightwatch 2 brings support for working with the newer Actions API from Selenium WebDriver for performing complex user gestures.
-- ##### [Integrated test runner for CucumberJS](https://nightwatchjs.org/guide/third-party-runners/cucumberjs-nightwatch-integration.html)
+- ##### [Integrated test runner for CucumberJS](/guide/third-party-runners/cucumberjs-nightwatch-integration.html)
Nightwatch 2 brings integrated support for using Cucumber.js directly as an alternative test runner. No other plugins are necessary, other than the Cucumber library itself (version 7.3 or higher).
-- ##### [Improved Mocha test runner](https://nightwatchjs.org/guide/third-party-runners/using-mocha.html)
-We have upgraded the integrated Mocha runner to Mocha v9. We have also updated the implementation to match most of the features that Nightwatch offers in its own default test runner, such as the ability to use tags or global test hooks. You can now also use reporters such as [Mochawesome](https://nightwatchjs.org/guide/third-party-runners/using-mocha.html#using-the-mochawesome-reporter).
+- ##### [Improved Mocha test runner](/guide/third-party-runners/using-mocha.html)
+We have upgraded the integrated Mocha runner to Mocha v9. We have also updated the implementation to match most of the features that Nightwatch offers in its own default test runner, such as the ability to use tags or global test hooks. You can now also use reporters such as [Mochawesome](/guide/third-party-runners/using-mocha.html#using-the-mochawesome-reporter).
- ##### [Support for Chrome DevTools Protocol](/api/commands/#using-chrome-devtools-protocol)
When using ChromeDriver or EdgeDriver it is now possible to execute commands via the [Chrome DevTools protocol](https://chromedevtools.github.io/devtools-protocol/).
@@ -62,10 +62,10 @@ We have tried to keep the breaking changes to a minimum, however some changes we
#### Release notes
Please refer to the release notes section for information about the latest changes.
-[Releases Notes](https://nightwatchjs.org/guide/overview/whats-new.html).
+[Releases Notes](/guide/overview/whats-new.html).
### Recommended content
-- [Nightwatch release notes](https://nightwatchjs.org/guide/overview/whats-new.html)
+- [Nightwatch release notes](/guide/overview/whats-new.html)
- [A First Look at Nightwatch v2.0](https://nightwatchjs.org/blog/a-first-look-at-nightwatch-v2.html)
- [Nightwatch v2 is Now in Beta](https://nightwatchjs.org/blog/nightwatch-v2-beta-is-available.html)
diff --git a/guide/overview/whats-new-in-v3.md b/docs/guide/overview/whats-new-in-v3.md
similarity index 97%
rename from guide/overview/whats-new-in-v3.md
rename to docs/guide/overview/whats-new-in-v3.md
index 960cd7ef..8d6b1b69 100644
--- a/guide/overview/whats-new-in-v3.md
+++ b/docs/guide/overview/whats-new-in-v3.md
@@ -51,7 +51,7 @@ We have tried to ensure that there are no breaking changes while upgrading to v3
#### Release notes
Please refer to the release notes section for information about the latest changes.
-[Releases Notes](https://nightwatchjs.org/guide/overview/whats-new.html).
+[Releases Notes](/guide/overview/whats-new.html).
### Key highlights from Nightwatch v2
@@ -103,7 +103,7 @@ Nightwatch v3 packages the [aXe-core][16] package developed by [Deque Systems][1
Relive the test as it happened by enabling DOM history. When this functionaity is enabled, DOM snapshots are captured after every test and displayed in the HTML report for better debugging.
## Recommended content
-- [Nightwatch release notes](https://nightwatchjs.org/guide/overview/whats-new.html)
+- [Nightwatch release notes](/guide/overview/whats-new.html)
[1]: /guide/writing-tests/nightwatch-inspector.html
[2]: /guide/component-testing/testing-angular-components.html
diff --git a/guide/overview/whats-new.md b/docs/guide/overview/whats-new.md
similarity index 100%
rename from guide/overview/whats-new.md
rename to docs/guide/overview/whats-new.md
diff --git a/guide/quickstarts/create-and-run-a-nightwatch-test.md b/docs/guide/quickstarts/create-and-run-a-nightwatch-test.md
similarity index 99%
rename from guide/quickstarts/create-and-run-a-nightwatch-test.md
rename to docs/guide/quickstarts/create-and-run-a-nightwatch-test.md
index e85cf946..bcb1d8db 100644
--- a/guide/quickstarts/create-and-run-a-nightwatch-test.md
+++ b/docs/guide/quickstarts/create-and-run-a-nightwatch-test.md
@@ -215,7 +215,7 @@ Now that you have installed Nightwatch
[11]: https://www.oracle.com/technetwork/java/javase/downloads/index.html
[12]: https://www.npmjs.com/package/selenium-server
[13]: https://github.com/SeleniumHQ/selenium/releases
-[15]: https://nightwatchjs.org/guide/third-party-runners/using-mocha.html
+[15]: /guide/third-party-runners/using-mocha.html
[16]: https://nightwatchjs.org/blog/running-cucumber-tests-with-nightwatch/
[17]: https://github.com/nightwatchjs/nightwatch/releases/tag/v1.6.0
[18]: /guide/writing-tests/introduction.html
diff --git a/guide/quickstarts/create-and-run-a-test-with-cloud-providers.md b/docs/guide/quickstarts/create-and-run-a-test-with-cloud-providers.md
similarity index 98%
rename from guide/quickstarts/create-and-run-a-test-with-cloud-providers.md
rename to docs/guide/quickstarts/create-and-run-a-test-with-cloud-providers.md
index d534b35d..534317b4 100644
--- a/guide/quickstarts/create-and-run-a-test-with-cloud-providers.md
+++ b/docs/guide/quickstarts/create-and-run-a-test-with-cloud-providers.md
@@ -192,7 +192,7 @@ If you are trying to set this up for an existing project, you will have to add t
...,
remote: {
// Info on all the available options with "selenium":
- // https://nightwatchjs.org/guide/configuration/settings.html#selenium-server-settings
+ // /guide/configuration/settings.html#selenium-server-settings
selenium: {
start_process: false,
server_path: '',
diff --git a/guide/quickstarts/create-and-run-a-test-with-selenium-server.md b/docs/guide/quickstarts/create-and-run-a-test-with-selenium-server.md
similarity index 100%
rename from guide/quickstarts/create-and-run-a-test-with-selenium-server.md
rename to docs/guide/quickstarts/create-and-run-a-test-with-selenium-server.md
diff --git a/guide/reference/.empty b/docs/guide/reference/.empty
similarity index 100%
rename from guide/reference/.empty
rename to docs/guide/reference/.empty
diff --git a/guide/reference/defaults.md b/docs/guide/reference/defaults.md
similarity index 98%
rename from guide/reference/defaults.md
rename to docs/guide/reference/defaults.md
index d160be27..c07b90fa 100644
--- a/guide/reference/defaults.md
+++ b/docs/guide/reference/defaults.md
@@ -270,8 +270,8 @@ module.exports = {
}
diff --git a/guide/reference/settings.md b/docs/guide/reference/settings.md
similarity index 98%
rename from guide/reference/settings.md
rename to docs/guide/reference/settings.md
index 64d48416..b5700f4e 100644
--- a/guide/reference/settings.md
+++ b/docs/guide/reference/settings.md
@@ -164,7 +164,7 @@ These settings are used to fine tune the behaviour of a test session and define
### Setting the `baseUrl` property
This `baseUrl` (or `launchUrl`) property will be made available to the main Nightwatch api which is used in the tests. Its value depends on which environment is used.
-More on test environments under the [Nightwatch Runner](https://nightwatchjs.org/guide/concepts/test-environments.html#defining-test-environments) section.
+More on test environments under the [Nightwatch Runner](/guide/concepts/test-environments.html#defining-test-environments) section.
If you run your tests specifying the `integration` environment (with `--env integration`) the `baseUrl` will be set to `http://staging.host`, as per the configuration. Otherwise it will have the value defined in the `default` environment (i.e. `http://localhost`).
@@ -258,7 +258,7 @@ module.exports = {
An object which will be made available within the test and can be overwritten per environment. Example:
"globals" : { "myGlobal" : "some_global" }
-
Globals can also be defined in an external file. More on [External Globals](https://nightwatchjs.org/guide/concepts/test-globals.html).
+
Globals can also be defined in an external file. More on [External Globals](/guide/concepts/test-globals.html).
@@ -830,8 +830,8 @@ Remember to also enable HTTP keepalive for improved network performance.
### Recommended content
-- [Default configuration](https://nightwatchjs.org/guide/reference/defaults.html)
-- [CLI options](https://nightwatchjs.org/guide/nightwatch-cli/command-line-options.html)
+- [Default configuration](/guide/reference/defaults.html)
+- [CLI options](/guide/nightwatch-cli/command-line-options.html)
diff --git a/guide/reporters/create-custom-reporter.md b/docs/guide/reporters/create-custom-reporter.md
similarity index 88%
rename from guide/reporters/create-custom-reporter.md
rename to docs/guide/reporters/create-custom-reporter.md
index d1748e7b..bb70d732 100644
--- a/guide/reporters/create-custom-reporter.md
+++ b/docs/guide/reporters/create-custom-reporter.md
@@ -85,13 +85,13 @@ The `index.js` file needs to implement the same interface as the file-based cust
### Recommended content
-- [BDD test syntax](https://nightwatchjs.org/guide/writing-tests/test-syntax-bdd.html)
-- [Using async/await](https://nightwatchjs.org/guide/writing-tests/using-es-6-async-await.html)
+- [BDD test syntax](/guide/writing-tests/test-syntax-bdd.html)
+- [Using async/await](/guide/writing-tests/using-es-6-async-await.html)
[2]: https://www.w3.org/TR/webdriver/#locator-strategies
[3]: https://www.w3.org/TR/webdriver/#elements
diff --git a/guide/writing-tests/global-test-hooks.md b/docs/guide/writing-tests/global-test-hooks.md
similarity index 100%
rename from guide/writing-tests/global-test-hooks.md
rename to docs/guide/writing-tests/global-test-hooks.md
diff --git a/guide/writing-tests/introduction.md b/docs/guide/writing-tests/introduction.md
similarity index 100%
rename from guide/writing-tests/introduction.md
rename to docs/guide/writing-tests/introduction.md
diff --git a/guide/writing-tests/nightwatch-inspector.md b/docs/guide/writing-tests/nightwatch-inspector.md
similarity index 100%
rename from guide/writing-tests/nightwatch-inspector.md
rename to docs/guide/writing-tests/nightwatch-inspector.md
diff --git a/guide/writing-tests/selectors.md b/docs/guide/writing-tests/selectors.md
similarity index 100%
rename from guide/writing-tests/selectors.md
rename to docs/guide/writing-tests/selectors.md
diff --git a/guide/writing-tests/test-doubles.md b/docs/guide/writing-tests/test-doubles.md
similarity index 100%
rename from guide/writing-tests/test-doubles.md
rename to docs/guide/writing-tests/test-doubles.md
diff --git a/guide/writing-tests/test-syntax-bdd.md b/docs/guide/writing-tests/test-syntax-bdd.md
similarity index 96%
rename from guide/writing-tests/test-syntax-bdd.md
rename to docs/guide/writing-tests/test-syntax-bdd.md
index e2db0396..4f6dad62 100644
--- a/guide/writing-tests/test-syntax-bdd.md
+++ b/docs/guide/writing-tests/test-syntax-bdd.md
@@ -267,9 +267,9 @@ We've put together a complete [Github template repo](https://github.com/nightwat
### Recommended content
-- [Exports test syntax](https://nightwatchjs.org/guide/writing-tests/test-syntax-exports.html)
-- [Using async/await](https://nightwatchjs.org/guide/writing-tests/using-es-6-async-await.html)
-- [Finding & interacting with DOM Elements](https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html)
+- [Exports test syntax](/guide/writing-tests/test-syntax-exports.html)
+- [Using async/await](/guide/writing-tests/using-es-6-async-await.html)
+- [Finding & interacting with DOM Elements](/guide/writing-tests/finding-interacting-with-dom-elements.html)
[1]: https://www.ecosia.org/
diff --git a/guide/writing-tests/test-syntax-exports.md b/docs/guide/writing-tests/test-syntax-exports.md
similarity index 96%
rename from guide/writing-tests/test-syntax-exports.md
rename to docs/guide/writing-tests/test-syntax-exports.md
index 3b4b0702..b90a9c11 100644
--- a/guide/writing-tests/test-syntax-exports.md
+++ b/docs/guide/writing-tests/test-syntax-exports.md
@@ -117,8 +117,8 @@ Or to skip multiple tags, add each tag you want to skip as comma-separated:
### Recommended content
-- [BDD test syntax](https://nightwatchjs.org/guide/writing-tests/test-syntax-bdd.html)
-- [Using async/await](https://nightwatchjs.org/guide/writing-tests/using-es-6-async-await.html)
+- [BDD test syntax](/guide/writing-tests/test-syntax-bdd.html)
+- [Using async/await](/guide/writing-tests/using-es-6-async-await.html)
[1]: https://www.ecosia.org/
diff --git a/guide/writing-tests/understanding-element-visibility.md b/docs/guide/writing-tests/understanding-element-visibility.md
similarity index 100%
rename from guide/writing-tests/understanding-element-visibility.md
rename to docs/guide/writing-tests/understanding-element-visibility.md
diff --git a/guide/writing-tests/using-bdd-describe.md b/docs/guide/writing-tests/using-bdd-describe.md
similarity index 95%
rename from guide/writing-tests/using-bdd-describe.md
rename to docs/guide/writing-tests/using-bdd-describe.md
index 100f749a..20e5256e 100644
--- a/guide/writing-tests/using-bdd-describe.md
+++ b/docs/guide/writing-tests/using-bdd-describe.md
@@ -141,5 +141,5 @@ describe('homepage test with describe', function() {
after(browser => browser.end());
});
-- Previous: [Writing Tests](https://nightwatchjs.org/guide/using-nightwatch/writing-tests.html)
-- Next: [Using ES6 async/await](https://nightwatchjs.org/guide/using-nightwatch/using-es6-async.html)
+- Previous: [Writing Tests](/guide/using-nightwatch/writing-tests.html)
+- Next: [Using ES6 async/await](/guide/using-nightwatch/using-es6-async.html)
diff --git a/guide/writing-tests/using-commands-to-perform-actions.md b/docs/guide/writing-tests/using-commands-to-perform-actions.md
similarity index 100%
rename from guide/writing-tests/using-commands-to-perform-actions.md
rename to docs/guide/writing-tests/using-commands-to-perform-actions.md
diff --git a/guide/writing-tests/using-cucumberjs.md b/docs/guide/writing-tests/using-cucumberjs.md
similarity index 98%
rename from guide/writing-tests/using-cucumberjs.md
rename to docs/guide/writing-tests/using-cucumberjs.md
index 4163fca9..978d15b9 100644
--- a/guide/writing-tests/using-cucumberjs.md
+++ b/docs/guide/writing-tests/using-cucumberjs.md
@@ -60,7 +60,7 @@ Parallel running using 2 workers:
-Use other [test runner options](https://nightwatchjs.org/guide/running-tests/command-line-options.html) as usual:
+Use other [test runner options](/guide/running-tests/command-line-options.html) as usual:
diff --git a/guide/writing-tests/using-es-6-async-await.md b/docs/guide/writing-tests/using-es-6-async-await.md
similarity index 88%
rename from guide/writing-tests/using-es-6-async-await.md
rename to docs/guide/writing-tests/using-es-6-async-await.md
index 746c3c22..11748d35 100644
--- a/guide/writing-tests/using-es-6-async-await.md
+++ b/docs/guide/writing-tests/using-es-6-async-await.md
@@ -47,9 +47,9 @@ Callbacks can still be used as before and if the callback returns a `Promise`, t
};
### Recommended content
-- [Writing tests > BDD describe test syntax](https://nightwatchjs.org/guide/writing-tests/test-syntax-bdd.html)
-- [Writing tests > Exports test syntax](https://nightwatchjs.org/guide/writing-tests/test-syntax-exports.html)
-- [Finding & interacting with DOM Elements](https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html)
+- [Writing tests > BDD describe test syntax](/guide/writing-tests/test-syntax-bdd.html)
+- [Writing tests > Exports test syntax](/guide/writing-tests/test-syntax-exports.html)
+- [Finding & interacting with DOM Elements](/guide/writing-tests/finding-interacting-with-dom-elements.html)
[8]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function
diff --git a/guide/writing-tests/using-es6-async.md b/docs/guide/writing-tests/using-es6-async.md
similarity index 88%
rename from guide/writing-tests/using-es6-async.md
rename to docs/guide/writing-tests/using-es6-async.md
index 67b55f63..895818eb 100644
--- a/guide/writing-tests/using-es6-async.md
+++ b/docs/guide/writing-tests/using-es6-async.md
@@ -38,8 +38,8 @@ Callbacks can still be used as before and if the callback returns a `Promise`, t
}
};
-- Previous: [Using BDD describe](https://nightwatchjs.org/guide/using-nightwatch/using-bdd-describe.html)
-- Next: [Finding & Interacting with Elements](https://nightwatchjs.org/guide/using-nightwatch/finding-and-interacting-with-elements.html)
+- Previous: [Using BDD describe](/guide/using-nightwatch/using-bdd-describe.html)
+- Next: [Finding & Interacting with Elements](/guide/using-nightwatch/finding-and-interacting-with-elements.html)
[8]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function
[9]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await
diff --git a/guide/writing-tests/using-exports.md b/docs/guide/writing-tests/using-exports.md
similarity index 94%
rename from guide/writing-tests/using-exports.md
rename to docs/guide/writing-tests/using-exports.md
index 2b3c8331..8b7712e4 100644
--- a/guide/writing-tests/using-exports.md
+++ b/docs/guide/writing-tests/using-exports.md
@@ -49,6 +49,6 @@ A test can have multiple steps, if needed:
}
};
-- Next: [Using BDD describe](https://nightwatchjs.org/guide/using-nightwatch/using-bdd-describe.html)
+- Next: [Using BDD describe](/guide/using-nightwatch/using-bdd-describe.html)
[1]: https://www.ecosia.org/
diff --git a/guide/writing-tests/using-mocha.md b/docs/guide/writing-tests/using-mocha.md
similarity index 98%
rename from guide/writing-tests/using-mocha.md
rename to docs/guide/writing-tests/using-mocha.md
index 719b3ab4..41b91fd2 100644
--- a/guide/writing-tests/using-mocha.md
+++ b/docs/guide/writing-tests/using-mocha.md
@@ -74,7 +74,7 @@ Here's the list of supported arguments presently:
### Extended describe() Syntax
-The new Mocha support in Nightwatch 2 has been built to match as close as possible the extended syntax which is available in the [built-in Nightwatch `describes()` syntax](https://nightwatchjs.org/guide/writing-tests/test-syntax-bdd.html).
+The new Mocha support in Nightwatch 2 has been built to match as close as possible the extended syntax which is available in the [built-in Nightwatch `describes()` syntax](/guide/writing-tests/test-syntax-bdd.html).
Here's the complete syntax available when using Mocha in Nightwatch:
diff --git a/guide/writing-tests/using-test-globals.md b/docs/guide/writing-tests/using-test-globals.md
similarity index 100%
rename from guide/writing-tests/using-test-globals.md
rename to docs/guide/writing-tests/using-test-globals.md
diff --git a/guide/writing-tests/using-test-hooks.md b/docs/guide/writing-tests/using-test-hooks.md
similarity index 100%
rename from guide/writing-tests/using-test-hooks.md
rename to docs/guide/writing-tests/using-test-hooks.md
diff --git a/guide/writing-tests/using-xpath-selectors.md b/docs/guide/writing-tests/using-xpath-selectors.md
similarity index 97%
rename from guide/writing-tests/using-xpath-selectors.md
rename to docs/guide/writing-tests/using-xpath-selectors.md
index 807e62ba..d10e36e8 100644
--- a/guide/writing-tests/using-xpath-selectors.md
+++ b/docs/guide/writing-tests/using-xpath-selectors.md
@@ -54,7 +54,7 @@ If you mostly are using XPath expressions and you want to avoid configuring the
diff --git a/guide/writing-tests/visual-regression-testing.md b/docs/guide/writing-tests/visual-regression-testing.md
similarity index 100%
rename from guide/writing-tests/visual-regression-testing.md
rename to docs/guide/writing-tests/visual-regression-testing.md
diff --git a/guide/writing-tests/write-complex-user-actions.md b/docs/guide/writing-tests/write-complex-user-actions.md
similarity index 98%
rename from guide/writing-tests/write-complex-user-actions.md
rename to docs/guide/writing-tests/write-complex-user-actions.md
index e0ffcf37..7b00db47 100644
--- a/guide/writing-tests/write-complex-user-actions.md
+++ b/docs/guide/writing-tests/write-complex-user-actions.md
@@ -16,7 +16,7 @@ The Actions API provides granular control over exactly what designated input dev
More information is available on the [W3C Webdriver spec page](https://w3c.github.io/webdriver/#dfn-actions).
### Example
-The new API is available and ready to use in Nightwatch via the existing [`.perform()`](https://nightwatchjs.org/api/perform.html) command. The previous functionality of the `perform()` command is still there and working in the same way as before.
+The new API is available and ready to use in Nightwatch via the existing [`.perform()`](/api/perform.html) command. The previous functionality of the `perform()` command is still there and working in the same way as before.
tests/sampleTest.js
describe('user actions api', function() {
diff --git a/guide/writing-tests/write-component-tests-for-react.md b/docs/guide/writing-tests/write-component-tests-for-react.md
similarity index 96%
rename from guide/writing-tests/write-component-tests-for-react.md
rename to docs/guide/writing-tests/write-component-tests-for-react.md
index abe74277..6e767fd5 100644
--- a/guide/writing-tests/write-component-tests-for-react.md
+++ b/docs/guide/writing-tests/write-component-tests-for-react.md
@@ -89,7 +89,7 @@ If you're not already using external globals with Nightwatch, go ahead and creat
}
-Read more about [test globals](https://nightwatchjs.org/guide/concepts/test-globals.html).
+Read more about [test globals](/guide/concepts/test-globals.html).
test/globals.js
const {setup} = require('@nightwatch/react');
@@ -131,7 +131,7 @@ Below is a basic test for the Form component. In this test we mount a component
### Recommended content
-- [Concepts > Component testing](https://nightwatchjs.org/guide/concepts/component-testing.html)
+- [Concepts > Component testing](/guide/concepts/component-testing.html)
- [Nightwatch React plugin on Github](https://github.com/nightwatchjs/nightwatch-plugin-react)
- [Sample todo app built with React and Vite and using Nightwatch for end-to-end & component tests](https://github.com/nightwatchjs-community/todo-react)
- [Blog > Introducing Component Testing in Nightwatch](https://nightwatchjs.org/blog/introducing-component-testing-in-nightwatch/)
diff --git a/guide/writing-tests/write-nodejs-unit-integration-tests.md b/docs/guide/writing-tests/write-nodejs-unit-integration-tests.md
similarity index 95%
rename from guide/writing-tests/write-nodejs-unit-integration-tests.md
rename to docs/guide/writing-tests/write-nodejs-unit-integration-tests.md
index d5ab670f..ceecd493 100644
--- a/guide/writing-tests/write-nodejs-unit-integration-tests.md
+++ b/docs/guide/writing-tests/write-nodejs-unit-integration-tests.md
@@ -157,7 +157,7 @@ An empty `exclude` means we want to reset its value and rely only on `filter`.
### Code Coverage
At the moment, Nightwatch doesn't provide a coverage reporter but it is something that's being planned for a future release.
-In the meantime you can write a custom reporter which will output coverage data. See the [custom reporter](https://nightwatchjs.org/guide/extending-nightwatch/adding-custom-reporters.html) section for details and the [Mocha HTMLCov](https://mochajs.org/#htmlcov) reporter for how the reporter should look like.
+In the meantime you can write a custom reporter which will output coverage data. See the [custom reporter](/guide/extending-nightwatch/adding-custom-reporters.html) section for details and the [Mocha HTMLCov](https://mochajs.org/#htmlcov) reporter for how the reporter should look like.
#### 3rd party coverage service
There are some hosted services which provide the reporting and metrics for you in a modern web interface. These services will typically require coverage data in LCOV format. Nightwatch uses [coveralls.io](https://coveralls.io/github/nightwatchjs/nightwatch?branch=main).
diff --git a/guide/writing-tests/writing-assertions.md b/docs/guide/writing-tests/writing-assertions.md
similarity index 86%
rename from guide/writing-tests/writing-assertions.md
rename to docs/guide/writing-tests/writing-assertions.md
index ada3d90e..8f82de08 100644
--- a/guide/writing-tests/writing-assertions.md
+++ b/docs/guide/writing-tests/writing-assertions.md
@@ -33,10 +33,10 @@ However, if you wish to keep the browser window open whenever an assertion failu
Refer to the [Configuration][7] section for details.
-- Previous: [Finding & Interacting with Elements](https://nightwatchjs.org/guide/using-nightwatch/finding-and-interacting-with-elements.html)
-- Next: [Using Expect Assertions](https://nightwatchjs.org/guide/using-nightwatch/expect-assertions.html)
+- Previous: [Finding & Interacting with Elements](/guide/using-nightwatch/finding-and-interacting-with-elements.html)
+- Next: [Using Expect Assertions](/guide/using-nightwatch/expect-assertions.html)
-[5]: https://nightwatchjs.org/guide/using-nightwatch/finding-and-interacting-with-elements.html#element-properties
+[5]: /guide/using-nightwatch/finding-and-interacting-with-elements.html#element-properties
[6]: /gettingstarted/configuration/#extended-settings
[7]: /gettingstarted/configuration/#extended-settings
diff --git a/guide/writing-tests/writing-component-tests.md b/docs/guide/writing-tests/writing-component-tests.md
similarity index 100%
rename from guide/writing-tests/writing-component-tests.md
rename to docs/guide/writing-tests/writing-component-tests.md
diff --git a/guide/writing-tests/writing-unit-tests.md b/docs/guide/writing-tests/writing-unit-tests.md
similarity index 100%
rename from guide/writing-tests/writing-unit-tests.md
rename to docs/guide/writing-tests/writing-unit-tests.md
diff --git a/index.md b/docs/index.md
similarity index 100%
rename from index.md
rename to docs/index.md
diff --git a/package.json b/package.json
index 3c9c555a..b43f5a4b 100644
--- a/package.json
+++ b/package.json
@@ -1,10 +1,36 @@
{
- "name": "nightwatch-docs",
+ "name": "nightwatchjs.org",
+ "type": "module",
"version": "0.0.1",
- "description": "Documentation source for nightwatchjs.org website",
- "main": "index.js",
- "dependencies": {},
- "devDependencies": {},
- "author": "Andrei Rusu",
- "license": "MIT"
+ "description": "Nightwatch.js website - https://nightwatchjs.org",
+ "scripts": {
+ "start": "postdoc run",
+ "serve": "postdoc preview",
+ "clone:docs": "rm -rf nightwatch-docs/ && git clone https://github.com/nightwatchjs/nightwatch-docs.git",
+ "clone:nightwatch": "rm -rf nightwatch/ && git clone https://github.com/nightwatchjs/nightwatch.git",
+ "build": "postdoc build",
+ "optimize": "node build/optimize.js",
+ "netlify": "npm run clone:docs && npm run clone:nightwatch && npm run build",
+ "partytown": "partytown copylib public/~partytown",
+ "eslint": "eslint src test --quiet"
+ },
+ "author": "Andrei Rusu ",
+ "license": "MIT",
+ "dependencies": {
+ "@builder.io/partytown": "^0.8.0",
+ "ejs": "^3.1.9",
+ "isomorphic-fetch": "^3.0.0",
+ "marked": "^4.3.0",
+ "prismjs": "^1.29.0",
+ "swiper": "^10.0.3"
+ },
+ "devDependencies": {
+ "@halo-lab/stream": "0.0.1",
+ "bootstrap": "^5.3.3",
+ "critical": "^7.1.0",
+ "eslint": "^8.32.0",
+ "html-minifier": "^4.0.0",
+ "nightwatch-examples": "nightwatchjs-community/nightwatch-examples",
+ "postdoc": "0.3.0-preview4"
+ }
}
diff --git a/postdoc.config.js b/postdoc.config.js
new file mode 100644
index 00000000..1cb9bbda
--- /dev/null
+++ b/postdoc.config.js
@@ -0,0 +1,105 @@
+import {env} from 'node:process';
+import {sep, join, basename, resolve, extname} from 'node:path';
+
+const {
+ NIGHTWATCH_VERSION = '3.5.0',
+ BASE_URL = 'https://nightwatchjs.org',
+ MD_DOCS_FOLDER = './docs',
+ API_DOCS_FOLDER = resolve('../nightwatch/lib/api'),
+ EXAMPLES_FOLDER = 'node_modules/nightwatch-examples/tests'
+} = env;
+
+export default {
+ vite: {
+ publicDir: resolve('./public'),
+ plugins: [
+
+ ]
+ },
+
+ session: {
+ enable_prefetch: false,
+ disable_spa: false
+ },
+
+ pwa: {
+ enabled: false
+ },
+
+ directories: {
+ output: './out',
+ includes: 'src/includes',
+ layouts: 'src/pages',
+ content: MD_DOCS_FOLDER,
+ },
+
+ ignore: {
+ pages: ['**/{README,LICENSE}.md', '**/blog/**'],
+ apidocs: ['**/_*/**', '**/_*.js', '**/api/index.js'],
+ layouts: ['**/example-*.ejs']
+ },
+
+ apidocs: {
+ source: API_DOCS_FOLDER,
+ layout: 'api/index.ejs',
+
+ createUrl(filePath) {
+ let fileName = basename(filePath, extname(filePath));
+
+ if (filePath.startsWith(sep + join('expect', 'assertions', 'elements'))) {
+ return `/api/expect/elements/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('expect', 'assertions', 'element'))) {
+ return `/api/expect/element/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('client-commands', 'window'))) {
+ return `/api/window/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('client-commands', 'network'))) {
+ return `/api/network/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('client-commands', 'document'))) {
+ return `/api/document/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('client-commands', 'cookies'))) {
+ return `/api/cookies/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('client-commands', 'alerts'))) {
+ return `/api/alerts/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + join('protocol', 'appium'))) {
+ return `/api/appium/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + 'protocol') || filePath.startsWith(sep + 'client-commands') || filePath.startsWith(sep + 'element-commands')) {
+ return `/api/${fileName}.html`;
+ }
+ if (filePath.startsWith(sep + 'web-element') || filePath.startsWith(sep + 'commands')) {
+ return `/api/element/${fileName}.html`;
+ }
+ if (filePath.includes('assertions')) {
+ return `/api/assert/${fileName}.html`;
+ }
+
+ return filePath.replaceAll(sep, '/');
+ }
+ },
+
+ appSettings: {
+ version: NIGHTWATCH_VERSION,
+ baseUrl: BASE_URL,
+ apiRepoUrl: 'https://github.com',
+ githubRepo: 'nightwatchjs/nightwatch',
+ docsRepoUrl: 'https://github.com/nightwatchjs/nightwatch-docs/blob/',
+ docsRepoBranch: 'versions/3.0',
+ mdFolder: MD_DOCS_FOLDER,
+ apiFolder: API_DOCS_FOLDER,
+ examples: {
+ output_folder: 'public/__examples',
+ source_folder: EXAMPLES_FOLDER
+ }
+ },
+
+ logger: {
+ quiet: false
+ }
+};
diff --git a/public/__playground/index.html b/public/__playground/index.html
new file mode 100644
index 00000000..af49f37c
--- /dev/null
+++ b/public/__playground/index.html
@@ -0,0 +1,69 @@
+
+
+
+ Testing Playground - Nightwatch.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/public/__playground/playground.js b/public/__playground/playground.js
new file mode 100644
index 00000000..da03d2ca
--- /dev/null
+++ b/public/__playground/playground.js
@@ -0,0 +1,205 @@
+StackBlitzSDK.embedProject(
+ 'container',
+ // Payload:
+ {
+ files: {
+ 'test/shadowRootExample.js': `test('Shadow root example test', async function (browser) {
+ await browser
+ .navigateTo('https://mdn.github.io/web-components-examples/popup-info-box-web-component/')
+ .waitForElementVisible('form');
+
+ const shadowRootEl = await browser.getShadowRoot('popup-info');
+ const infoElement = await shadowRootEl.find('.info');
+
+ await expect(infoElement.property('innerHTML')).to.include('card validation code');
+ const iconElement = await shadowRootEl.find('.icon');
+ const firstElement = await browser.getFirstElementChild(iconElement);
+
+ await expect.element(firstElement).to.be.an('img');
+
+});`,
+
+ 'test/vueTodoList.js': `/**
+ * End-to-end test for the sample Vue3+Vite todo app located at
+ *
+ * https://github.com/nightwatchjs-community/todo-vue
+ */
+describe('To-Do List End-to-End Test', function() {
+
+ // using the new element() global utility in Nightwatch 2 to init elements
+ // before tests and use them later
+ const todoElement = element('#new-todo-input');
+ const addButtonEl = element('form button[type="submit"]');
+
+ it('should add a todo using global element()', async function() {
+ ///////////////////////////////////////////////////
+ // browser can now also be accessed as a global |
+ ///////////////////////////////////////////////////
+
+ // adding a new task to the list
+ await browser
+ .navigateTo('https://todo-vue3-vite.netlify.app/')
+ .sendKeys(todoElement, 'what is nightwatch?')
+ .click(addButtonEl);
+
+ ///////////////////////////////////////////////////
+ // global expect is equivalent to browser.expect |
+ ///////////////////////////////////////////////////
+
+ // verifying if there are 5 tasks in the list
+ await expect.elements('#todo-list ul li').count.toEqual(5);
+
+ // verifying if the 4th task if the one we have just added
+ const lastElementTask = element({
+ selector: '#todo-list ul li',
+ index: 4
+ });
+
+ await expect(lastElementTask).text.toContain('what is nightwatch?');
+
+ // find our task in the list and mark it as done
+ const inputElement = await lastElementTask.findElement('input[type="checkbox"]');
+ await browser.click(inputElement);
+
+ // verify if there are 3 tasks which are marked as done in the list
+ await expect.elements('#todo-list ul li input:checked').count.toEqual(3);
+ });
+
+});
+`,
+ 'test/usingFrames.js': `describe('Using frames in e2e tests', function () {
+
+ beforeEach(browser => browser.navigateTo('https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe'));
+ afterEach(browser => browser.end());
+
+ // with css selector
+ it('Using .frame() test with CSS selector', function (browser) {
+ const frameId = 'iframe.interactive';
+
+ browser
+ .navigateTo('https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe')
+ .frame(frameId, function (result) {
+ console.log(result);
+ })
+ .assert.visible('#editor-container')
+ .end();
+ });
+
+ it('Using frameElement example', function (browser) {
+ const frameElement = 'iframe.interactive';
+
+ browser
+ .assert.elementPresent(frameElement)
+ .frame(frameElement, function() {
+ console.log(' > Switched to the inner iframe');
+ })
+ .assert.visible('#editor-container')
+ .frameParent(function (result) {
+ console.log(' > Switched back to the parent frame');
+ })
+ .assert.visible('.main-wrapper');
+ });
+});
+
+ `,
+
+ 'README.md': `# Nightwatch Playground
+
+ This is a live example of a Nightwatch.js project. The tests run in the browser against a remote Chrome driver service, so you can try it out without installing anything.
+
+ ## How to run the tests
+
+ The project runs npm install automatically so you can go ahead an run the tests with:
+
+ \`\`\`sh
+ npm test
+ \`\`\`
+
+ To run the tests and view the HTML report in the Preview pane, run:
+
+ \`\`\`sh
+ npm run test:with-preview
+ \`\`\`
+
+ Feel free to edit the test file or add your own. You can also add new files and folders to the project.
+`,
+ 'package.json': `{
+ "name": "nightwatch-playground",
+ "version": "0.0.0",
+ "scripts": {
+ "start" : "pwd",
+ "test": "nightwatch",
+ "test:with-preview": "nightwatch --env stackblitz"
+ },
+ "dependencies": {
+ "nightwatch": "latest",
+ "serve-handler": "^6.1.3"
+ }
+
+}`,
+ 'nightwatch.conf.js': `
+module.exports = {
+ src_folders: ['test'],
+
+ test_settings: {
+ default: {
+ launch_url: 'https://nightwatchjs.org',
+
+ screenshots: {
+ enabled: true,
+ path: 'screens',
+ on_failure: true
+ },
+
+ desiredCapabilities: {
+ browserName: 'chrome',
+ 'goog:chromeOptions': {}
+ },
+
+ webdriver: {
+ default_path_prefix: '',
+ start_process: false,
+ host: 'remotedriver.nightwatchjs.org',
+ port: 443
+ }
+ },
+
+ stackblitz: {
+ globals: {
+ after(done) {
+ const handler = require('serve-handler');
+ const http = require('http');
+
+ const server = http.createServer((request, response) => {
+ return handler(request, response, {
+ public: './tests_output/nightwatch-html-report',
+ });
+ });
+
+ server.listen(3000, () => {
+ console.log('Server running at http://localhost:3000. Make sure to enable third-party cookies for nightwatchjs.org in order to view the HTML report.');
+ });
+ done();
+ }
+ }
+ }
+ }
+};`
+ },
+ template: 'node',
+ title: 'Nightwatch Playground',
+ description: 'Create and run Nightwatch tests directly in your browser.',
+ },
+
+ // Options
+ {
+ clickToLoad: false,
+ hideNavigation: false,
+ hideExplorer: false ,
+ terminalHeight: 45 ,
+ height: document.body.clientHeight - 100,
+ showSidebar: true,
+ view: 'both',
+ openFile: 'README.md'
+ }
+);
diff --git a/public/__playground/stackblitz.1.8.2.js b/public/__playground/stackblitz.1.8.2.js
new file mode 100644
index 00000000..be5ff44a
--- /dev/null
+++ b/public/__playground/stackblitz.1.8.2.js
@@ -0,0 +1,2 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e||self).StackBlitzSDK=t()}(this,function(){var e=["angular-cli","create-react-app","html","javascript","node","polymer","typescript","vue"],t={clickToLoad:function(e){return r("ctl",e)},devToolsHeight:function(e){return i("devtoolsheight",e)},forceEmbedLayout:function(e){return r("embed",e)},hideDevTools:function(e){return r("hidedevtools",e)},hideExplorer:function(e){return r("hideExplorer",e)},hideNavigation:function(e){return r("hideNavigation",e)},showSidebar:function(e){return function(e,t){return"boolean"==typeof t?"showSidebar="+(t?"1":"0"):""}(0,e)},openFile:function(e){return function(e,t){return(Array.isArray(t)?t:[t]).filter(function(e){return"string"==typeof e&&""!==e.trim()}).map(function(e){return"file="+encodeURIComponent(e.trim())})}(0,e).join("&")},terminalHeight:function(e){return i("terminalHeight",e)},theme:function(e){return o("theme",["light","dark"],e)},view:function(e){return o("view",["preview","editor"],e)}};function n(e){void 0===e&&(e={});var n=Object.entries(e).map(function(e){var n=e[0],r=e[1];return null!=r&&t.hasOwnProperty(n)?t[n](r):""}).filter(Boolean);return n.length?"?"+n.join("&"):""}function r(e,t){return!0===t?e+"=1":""}function i(e,t){return"number"==typeof t&&t>=0&&t<=100?e+"="+Math.round(t):""}function o(e,t,n){return"string"==typeof n&&t.includes(n)?e+"="+n:""}function a(){return Math.random().toString(36).slice(2,6)+Math.random().toString(36).slice(2,6)}function d(e,t){return""+c(t)+e+n(t)}function u(e,t){var r={forceEmbedLayout:!0};return t&&"object"==typeof t&&Object.assign(r,t),""+c(r)+e+n(r)}function c(e){return void 0===e&&(e={}),"string"==typeof e.origin?e.origin:"https://stackblitz.com"}function s(e,t,n){if(!t||!e||!e.parentNode)throw new Error("Invalid Element");e.id&&(t.id=e.id),e.className&&(t.className=e.className),function(e,t){t&&"object"==typeof t&&(Object.hasOwnProperty.call(t,"height")&&(e.height=""+t.height),Object.hasOwnProperty.call(t,"width")&&(e.width=""+t.width)),e.height||(e.height="300"),e.width||e.setAttribute("style","width:100%;")}(t,n),e.parentNode.replaceChild(t,e)}function l(e){if("string"==typeof e){var t=document.getElementById(e);if(!t)throw new Error("Could not find element with id '"+e+"'");return t}if(e instanceof HTMLElement)return e;throw new Error("Invalid element: "+e)}function p(e){return e&&!1===e.newWindow?"_self":"_blank"}function f(){return f=Object.assign||function(e){for(var t=1;t=20)return o(),n("Timeout: Unable to establish a connection with the StackBlitz VM"),void v.forEach(function(e,n){e.id===t.id&&v.splice(n,1)});a++,i()}},500)}),v.push(this)};function g(e,t){var n=document.createElement("input");return n.type="hidden",n.name=e,n.value=t,n}function w(t){if(!e.includes(t.template)){var n=e.map(function(e){return"'"+e+"'"}).join(", ");console.warn("Unsupported project.template: must be one of "+n)}var r="node"===t.template,i=document.createElement("form");return i.method="POST",i.setAttribute("style","display:none!important;"),i.appendChild(g("project[title]",t.title)),i.appendChild(g("project[description]",t.description)),i.appendChild(g("project[template]",t.template)),t.dependencies&&(r?console.warn("Invalid project.dependencies: dependencies must be provided as a 'package.json' file when using the 'node' template."):i.appendChild(g("project[dependencies]",JSON.stringify(t.dependencies)))),t.settings&&i.appendChild(g("project[settings]",JSON.stringify(t.settings))),Object.keys(t.files).forEach(function(e){var n="project[files]"+function(e){return"["+e.replace(/\[/g,"%5B").replace(/\]/g,"%5D")+"]"}(e),r=t.files[e];"string"==typeof r&&i.appendChild(g(n,r))}),i}function _(e){var t,n,r,i;return null!=e&&e.contentWindow?(null!=(i=(n=e)instanceof Element?"element":"id",t=null!=(r=v.find(function(e){return e[i]===n}))?r:null)?t:new y(e)).pending:Promise.reject("Provided element is not an iframe.")}return{connect:_,embedGithubProject:function(e,t,n){var r=l(e),i=document.createElement("iframe");return i.src=u("/github/"+t,n),s(r,i,n),_(i)},embedProject:function(e,t,n){var r,i=l(e),o=function(e,t){var n=w(e);return n.action=u("/run",t),n.id="sb",""+n.outerHTML+"
+
+
+ Or run locally with:
+
+
\ No newline at end of file
diff --git a/src/includes/scripts.ejs b/src/includes/scripts.ejs
new file mode 100644
index 00000000..7148e6d1
--- /dev/null
+++ b/src/includes/scripts.ejs
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+<%- prism() %>
diff --git a/src/includes/sections/about.ejs b/src/includes/sections/about.ejs
new file mode 100644
index 00000000..c7b85671
--- /dev/null
+++ b/src/includes/sections/about.ejs
@@ -0,0 +1,568 @@
+
+
+
+
+
+
+ About pages
+
+
+
+
+
+
+
+
+
About Nightwatch
+
+
Nightwatch was published in January 2014, initially created by Andrei Rusu as a tool to enable writing of
+ automated UI tests in a straightforward way, and which will require as little configuration and additional
+ libraries as possible.
+
+ Right after it was published, Nightwatch has seen steady growth and has now become one of
+ the most popular Node.js end-to-end testing solutions for web applications and websites.
+
+
+
+ From the very first Github Issue opened by Evan You (creator of Vue.js) and seamless integration with the Vue.js framework, to being
+ featured on the 2017 ThoughtWorks Technology Radar,
+ Nightwatch has become an established household name in the wider automated testing
+ industry.
+
+
+
+
+
Our Vision
+
+ Instead of building a highly flexible tool which supports a lot of plugins and customization we aim to
+ deliver a tool that is packed with everything you need out of the box.
+
+
+
+ We believe that in order to write tests you should only focus on writing tests and not have to add
+ multiple external plugins and dependencies. In our experience, this usually leads to increasingly more
+ time spent on maintaining dependencies and solving configuration issues, instead of writing actual
+ tests.
+
+ You can even write Node.js unit tests in Nightwatch
+ to
+ test your backend APIs. These tests are using the same assertion libraries and the same syntax and
+ runner.
+ We can even combine end-to-end tests with unit/integration tests in the same test run.
+
+
+
+
+
Roadmap
+
Current Version – 1.7
+
+
This version adds integrated support for the latest Microsoft Edge browser, improved parallelism
+ support,
+ and a few other features and improvements (such as making the API work with both chaining and promises).
+
+
+
Version 2
+
We are working towards releasing the next major version which will be built on top of the Selenium Webdriver, which
+ will be making test run significantly more stable and more reliable.
+
We'll also add a few new capabilities, such as support for Chrome Dev Tools
+ Protocol, file uploads, and a new APIs.
You're encouraged to ask any questions you might have regarding the usage of Nightwatch or its APIs on
+ the
+ Github Discussions
+ page.
+
+ For reporting bugs, please submit a new Bug report on Github. Feature requests are also welcome.
+
+
New contributors: please also have a look at these resources:
We have setup a new chat server on Discord where you can chat with Nightwatch team members and other
+ users.
+ Please use this link to get in: https://discord.gg/SN8Da2X
+
+
On Twitter
+
We are on Twitter at @nightwatchjs where
+ we
+ post updates about releases and other type of announcements.
+ A curated list of articles, guides, and video tutorials from the wider Nightwatch community.
+ Please note that the videos and articles listed here aren't created by the Nightwatch team and we cannot
+ guarantee their full accuracy.
+
Learn how to write automated accessibility tests using Nightwatch and the
+ Axe accessibility tool. The tutorial will
+ explain how to write assertions for web content accessibility guidelines and detect elements which are
+ failing accessibility rules.
+
Nightwatch collaborator Domenico explains why end-to-end testing (and also
+ other forms of testing) is an important topic to him.
+ A good explanation of the testing pyramid concept and a good introduction to automated testing.
Domenico demonstrates how to run end-to-end tests with Nightwatch using the
+ Browserstack cloud testing platform.
+ You can find other Nightwatch-related coding videos on his Youtube
+ channel.
+
The platform that powers the Firefox Public Data
+ Report, a weekly public report on the activity, behavior, and hardware configuration of Firefox
+ Desktop users.
+ Built with React and using Nightwatch v1.2
Run your tests on real desktop and mobile
+ browsers
+ instead of browser engines
+
+
+
+
+
+
+
+
Native mobile testing
+
Test your native iOS and Android
+ applications without
+ any learning curve
+
+
+
+
+
+
+
+
Web standards
+
Nightwatch follows W3C protocol so your
+ interactions
+ reflect a real user
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Hearfrom the best
+
+
+
+
+
Nightwatch.js has been making remarkable strides since v2, with a steadfast commitment to enhancing the modern dev experience & providing aid to open-source users.
+
+
+
+
Nightwatch’s intuitive API & syntax makes testing reliable & maintainable. Faster feedback loops via parallel testing lead to faster deployments. Highly recommended!
+
+
+
+
The component testing side of Nightwatch is so good there’s almost no point doing the other class of test in test/e2e. Game changer stuff.
+ 
### Recommended content
-- [API docs > `.pause()`](https://nightwatchjs.org/api/pause.html)
-- [API docs > `.debug()`](https://nightwatchjs.org/api/debug.html)
+- [API docs > `.pause()`](/api/pause.html)
+- [API docs > `.debug()`](/api/debug.html)
### Recommended content
-- [API docs > `.pause()`](https://nightwatchjs.org/api/pause.html)
-- [API docs > `.debug()`](https://nightwatchjs.org/api/debug.html)
+- [API docs > `.pause()`](/api/pause.html)
+- [API docs > `.debug()`](/api/debug.html)
### Recommended content
-- [How-to guides > Use reporters > HTML reporter](https://nightwatchjs.org/guide/reporters/use-html-reporter.html)
-- [How-to guides > Use reporters > Add custom reporter](https://nightwatchjs.org/guide/reporters/create-custom-reporter.html)
-- [How-to guides > Use reporters > Mochawesome reporter reporter](https://nightwatchjs.org/guide/reporters/use-mochawesome-reporter.html)
+- [How-to guides > Use reporters > HTML reporter](/guide/reporters/use-html-reporter.html)
+- [How-to guides > Use reporters > Add custom reporter](/guide/reporters/create-custom-reporter.html)
+- [How-to guides > Use reporters > Mochawesome reporter reporter](/guide/reporters/use-mochawesome-reporter.html)
diff --git a/guide/reporters/use-junit-reporter.md b/docs/guide/reporters/use-junit-reporter.md
similarity index 88%
rename from guide/reporters/use-junit-reporter.md
rename to docs/guide/reporters/use-junit-reporter.md
index ec0936cc..71d0e216 100644
--- a/guide/reporters/use-junit-reporter.md
+++ b/docs/guide/reporters/use-junit-reporter.md
@@ -22,7 +22,7 @@ The `output_folder` config settings is used to specify the location where the JU
output_folder: 'tests_output'
}
-Refer to the [Configuration > Output settings](https://nightwatchjs.org/guide/configuration/customising-test-output.html) page for a complete list of test output related settings.
+Refer to the [Configuration > Output settings](/guide/configuration/customising-test-output.html) page for a complete list of test output related settings.
#### Via the CLI
@@ -30,7 +30,7 @@ You can also configure the output folder at runtime via the CLI, using the `--ou
+
+
+ Tutorial
+ 
+
+
+ Tutorial + Video
+ 
+
+
+ Video Course
+ 
+
+
+ Video
+ 
+
+
+ Video
+ 
+
+
+ Video
+ 
+
+
+ Video
+ 
+
+
+ Article
+ 
+
+
+ Article
+ 
+
+
+ Article
+ 
+
+
+ Article
+ 
+
+
+ Article
+ 
+ Nightwatch
+ 
+ Playwright
+ 
+ Chrome
+
+
+ 
+ Firefox
+
+
+ 
+ Edge
+
+
+ 
+ Safari
+
+ _2.png)
+ Webkit Engine (Safari)
+
+ 
+ 
+ 
+ 
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+
+