Merge website code from nightwatch-www repo (#288)

* Added website files * fixed internal links
nightwatchjs · Mar 24, 2024 · 4b93a45 · 4b93a45
1 parent 31ba9d3
commit 4b93a45
Show file tree

Hide file tree

Showing 613 changed files with 38,345 additions and 225 deletions.
diff --git a/.github/workflows/deploy-preview.yml b/.github/workflows/deploy-preview.yml
@@ -0,0 +1,51 @@
+name: Build and Deploy
+
+on:
+  push:
+    branches:
+      - 'preview'
+      - 'versions/3.0-complete'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      BASE_URL: https://dev.nightwatchjs.org
+      REMOTE_SERVER: ${{ secrets.REMOTE_SERVER }}
+      REMOTE_USER: ${{ secrets.REMOTE_USER }}
+      API_DOCS_FOLDER: ${{ github.workspace }}/nightwatch/lib/api
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Checkout Nightwatch source code
+        uses: actions/checkout@v2
+        with:
+          repository: nightwatchjs/nightwatch
+          path: nightwatch
+
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build the website
+        run: npm run build
+
+      - name: Creating symlinks to old version
+        run: |
+          ln -s ../nightwatchjs.org out/v17
+          ln -s ../v09.nightwatchjs.org out/v09
+          ln -s ../nightwatch-v26 out/v26
+
+      - name: Deploy to server
+        run: |
+          mkdir -p ~/.ssh
+          echo "${{ secrets.PROD_DEPLOY_SECRET }}" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+          ssh-keyscan ${{ env.REMOTE_SERVER }} >> ~/.ssh/known_hosts
+          rsync -azP --delete ./out/ ${{ env.REMOTE_USER }}@${{ env.REMOTE_SERVER }}:${{ secrets.REMOTE_PREVIEW_DIRECTORY }}
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,23 @@
 node_modules
 .idea
 *.plist
+.idea/
+.vscode/
 
-api/**/*.ejs
+# Dependency directories
+node_modules/
+logs
+
+# Postdoc output directory
+out/
+output/
+
+# dotenv environment variables file
+.env
+.env.local
+
+# Nightwatch output directory
+tests_output
+/public/__examples/
+package-lock.json
+.pd*
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Nightwatch Documentation
+# Nightwatch.js Documentation
 
 Documentation sources for [nightwatchjs.org](http://nightwatchjs.org) website.
 
@@ -10,12 +10,73 @@ Documentation sources for [nightwatchjs.org](http://nightwatchjs.org) website.
 [![Twitter Follow](https://img.shields.io/twitter/follow/nightwatchjs.svg?style=social)](https://twitter.com/nightwatchjs)
 
 <p align="center">
-  <img alt="Nightwatch.js Schematic Logo" src="https://raw.githubusercontent.com/nightwatchjs/nightwatch/f214d79b3f7d0cf7602a6b57823420baaa3b5282/.github/assets/nightwatch-logo.svg" width=300 />
+  <img alt="Nightwatch.js Logo" src="https://raw.githubusercontent.com/nightwatchjs/nightwatch/main/.github/assets/nightwatch-logo.png" width=300 />
 </p>
 
-#### [Homepage](https://nightwatchjs.org) &bullet; [Getting Started](https://nightwatchjs.org/gettingstarted) &bullet; [Developer Guide](https://nightwatchjs.org/guide) &bullet; [API Reference](https://nightwatchjs.org/api) &bullet; [About](https://nightwatchjs.org/about)
+#### [Homepage](https://nightwatchjs.org) &bullet; [Developer Guide](https://nightwatchjs.org/guide) &bullet; [API Reference](https://nightwatchjs.org/api) &bullet; [About](https://nightwatchjs.org/about) &bullet; [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
@@ -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 → docs/about/community/index.md b/about/community/index.md → docs/about/community/index.md
diff --git a/about/contribute/index.md → docs/about/contribute/index.md b/about/contribute/index.md → docs/about/contribute/index.md
diff --git a/about/highlights/beyond-e2e.md → docs/about/highlights/beyond-e2e.md b/about/highlights/beyond-e2e.md → docs/about/highlights/beyond-e2e.md
diff --git a/about/highlights/developer-experience.md → .../about/highlights/developer-experience.md b/about/highlights/developer-experience.md → .../about/highlights/developer-experience.md
diff --git a/about/highlights/index.md → docs/about/highlights/index.md b/about/highlights/index.md → docs/about/highlights/index.md
diff --git a/about/highlights/types-of-testing.md → docs/about/highlights/types-of-testing.md b/about/highlights/types-of-testing.md → docs/about/highlights/types-of-testing.md
diff --git a/about/index.md → docs/about/index.md b/about/index.md → docs/about/index.md
diff --git a/api/alerts/index.md → docs/api/alerts/index.md b/api/alerts/index.md → docs/api/alerts/index.md
diff --git a/api/appium/index.md → docs/api/appium/index.md b/api/appium/index.md → docs/api/appium/index.md
diff --git a/api/assert/index.md → docs/api/assert/index.md b/api/assert/index.md → docs/api/assert/index.md
diff --git a/api/assertions.md → docs/api/assertions.md b/api/assertions.md → docs/api/assertions.md
diff --git a/api/chrome/index.md → docs/api/chrome/index.md b/api/chrome/index.md → docs/api/chrome/index.md
diff --git a/api/commands.md → docs/api/commands.md b/api/commands.md → docs/api/commands.md
diff --git a/api/commands/index.md → docs/api/commands/index.md b/api/commands/index.md → docs/api/commands/index.md
diff --git a/api/cookies/index.md → docs/api/cookies/index.md b/api/cookies/index.md → docs/api/cookies/index.md
diff --git a/api/document/index.md → docs/api/document/index.md b/api/document/index.md → docs/api/document/index.md
diff --git a/api/element.md → docs/api/element.md b/api/element.md → docs/api/element.md
diff --git a/api/element/index.md → docs/api/element/index.md b/api/element/index.md → docs/api/element/index.md
diff --git a/api/ensure.md → docs/api/ensure.md b/api/ensure.md → docs/api/ensure.md
diff --git a/api/ensure/index.md → docs/api/ensure/index.md b/api/ensure/index.md → docs/api/ensure/index.md
diff --git a/api/expect.md → docs/api/expect.md b/api/expect.md → docs/api/expect.md
diff --git a/api/expect/_cookie.md → docs/api/expect/_cookie.md b/api/expect/_cookie.md → docs/api/expect/_cookie.md
diff --git a/api/expect/_element.md → docs/api/expect/_element.md b/api/expect/_element.md → docs/api/expect/_element.md
diff --git a/api/expect/_elements.md → docs/api/expect/_elements.md b/api/expect/_elements.md → docs/api/expect/_elements.md
diff --git a/api/expect/_title.md → docs/api/expect/_title.md b/api/expect/_title.md → docs/api/expect/_title.md
diff --git a/api/expect/_url.md → docs/api/expect/_url.md b/api/expect/_url.md → docs/api/expect/_url.md
diff --git a/api/expect/element/index.md → docs/api/expect/element/index.md b/api/expect/element/index.md → docs/api/expect/element/index.md
diff --git a/api/expect/elements/index.md → docs/api/expect/elements/index.md b/api/expect/elements/index.md → docs/api/expect/elements/index.md
diff --git a/api/expect/index.md → docs/api/expect/index.md b/api/expect/index.md → docs/api/expect/index.md
diff --git a/api/firefox/index.md → docs/api/firefox/index.md b/api/firefox/index.md → docs/api/firefox/index.md
diff --git a/api/index.md → docs/api/index.md b/api/index.md → docs/api/index.md
diff --git a/api/method/clearValue.md → docs/api/method/clearValue.md b/api/method/clearValue.md → docs/api/method/clearValue.md
diff --git a/api/method/click.md → docs/api/method/click.md b/api/method/click.md → docs/api/method/click.md
diff --git a/api/method/end.md → docs/api/method/end.md b/api/method/end.md → docs/api/method/end.md
diff --git a/api/method/executeAsync.md → docs/api/method/executeAsync.md b/api/method/executeAsync.md → docs/api/method/executeAsync.md
diff --git a/api/page.md → docs/api/page.md b/api/page.md → docs/api/page.md
diff --git a/api/pageobject/index.md → docs/api/pageobject/index.md b/api/pageobject/index.md → docs/api/pageobject/index.md
diff --git a/api/programmatic.md → docs/api/programmatic.md b/api/programmatic.md → docs/api/programmatic.md
diff --git a/api/programmatic/index.md → docs/api/programmatic/index.md b/api/programmatic/index.md → docs/api/programmatic/index.md
diff --git a/api/useractions.md → docs/api/useractions.md b/api/useractions.md → docs/api/useractions.md
diff --git a/api/useractions/index.md → docs/api/useractions/index.md b/api/useractions/index.md → docs/api/useractions/index.md
diff --git a/api/window/index.md → docs/api/window/index.md b/api/window/index.md → docs/api/window/index.md
diff --git a/guide/browser-drivers/chromedriver.md → docs/guide/browser-drivers/chromedriver.md b/guide/browser-drivers/chromedriver.md → docs/guide/browser-drivers/chromedriver.md
diff --git a/guide/browser-drivers/edgedriver.md → docs/guide/browser-drivers/edgedriver.md b/guide/browser-drivers/edgedriver.md → docs/guide/browser-drivers/edgedriver.md
diff --git a/...e/browser-drivers/gecko-driver-firefox.md → ...e/browser-drivers/gecko-driver-firefox.md b/...e/browser-drivers/gecko-driver-firefox.md → ...e/browser-drivers/gecko-driver-firefox.md
diff --git a/guide/browser-drivers/geckodriver.md → docs/guide/browser-drivers/geckodriver.md b/guide/browser-drivers/geckodriver.md → docs/guide/browser-drivers/geckodriver.md
diff --git a/guide/browser-drivers/safaridriver.md → docs/guide/browser-drivers/safaridriver.md b/guide/browser-drivers/safaridriver.md → docs/guide/browser-drivers/safaridriver.md
diff --git a/...ions/run-nightwatch-on-azure-pipelines.md → ...ions/run-nightwatch-on-azure-pipelines.md b/...ions/run-nightwatch-on-azure-pipelines.md → ...ions/run-nightwatch-on-azure-pipelines.md
diff --git a/...-integrations/run-nightwatch-on-bamboo.md → ...-integrations/run-nightwatch-on-bamboo.md b/...-integrations/run-nightwatch-on-bamboo.md → ...-integrations/run-nightwatch-on-bamboo.md
diff --git a/...ntegrations/run-nightwatch-on-circleci.md → ...ntegrations/run-nightwatch-on-circleci.md b/...ntegrations/run-nightwatch-on-circleci.md → ...ntegrations/run-nightwatch-on-circleci.md
diff --git a/...tions/run-nightwatch-on-github-actions.md → ...tions/run-nightwatch-on-github-actions.md b/...tions/run-nightwatch-on-github-actions.md → ...tions/run-nightwatch-on-github-actions.md
diff --git a/...-integrations/run-nightwatch-on-gitlab.md → ...-integrations/run-nightwatch-on-gitlab.md b/...-integrations/run-nightwatch-on-gitlab.md → ...-integrations/run-nightwatch-on-gitlab.md
diff --git a/...integrations/run-nightwatch-on-jenkins.md → ...integrations/run-nightwatch-on-jenkins.md b/...integrations/run-nightwatch-on-jenkins.md → ...integrations/run-nightwatch-on-jenkins.md
diff --git a/guide/comparison-with-leading-frameworks.md → ...ide/comparison-with-leading-frameworks.md b/guide/comparison-with-leading-frameworks.md → ...ide/comparison-with-leading-frameworks.md
diff --git a/guide/component-testing/debugging.md → docs/guide/component-testing/debugging.md b/guide/component-testing/debugging.md → docs/guide/component-testing/debugging.md
diff --git a/guide/component-testing/introduction.md → docs/guide/component-testing/introduction.md b/guide/component-testing/introduction.md → docs/guide/component-testing/introduction.md
diff --git a/...nt-testing/storybook-component-testing.md → ...nt-testing/storybook-component-testing.md b/...nt-testing/storybook-component-testing.md → ...nt-testing/storybook-component-testing.md
diff --git a/...ent-testing/testing-angular-components.md → ...ent-testing/testing-angular-components.md b/...ent-testing/testing-angular-components.md → ...ent-testing/testing-angular-components.md
diff --git a/...onent-testing/testing-react-components.md → ...onent-testing/testing-react-components.md b/...onent-testing/testing-react-components.md → ...onent-testing/testing-react-components.md
diff --git a/...mponent-testing/testing-vue-components.md → ...mponent-testing/testing-vue-components.md b/...mponent-testing/testing-vue-components.md → ...mponent-testing/testing-vue-components.md
diff --git a/guide/component-testing/vite-plugin.md → docs/guide/component-testing/vite-plugin.md b/guide/component-testing/vite-plugin.md → docs/guide/component-testing/vite-plugin.md
diff --git a/...omponent-testing/write-jsx-react-tests.md → ...omponent-testing/write-jsx-react-tests.md b/...omponent-testing/write-jsx-react-tests.md → ...omponent-testing/write-jsx-react-tests.md
diff --git a/guide/concepts/component-testing.md → docs/guide/concepts/component-testing.md b/guide/concepts/component-testing.md → docs/guide/concepts/component-testing.md
diff --git a/...introduction-to-selenium-and-webdriver.md → ...introduction-to-selenium-and-webdriver.md b/...introduction-to-selenium-and-webdriver.md → ...introduction-to-selenium-and-webdriver.md
diff --git a/guide/concepts/page-object-model.md → docs/guide/concepts/page-object-model.md b/guide/concepts/page-object-model.md → 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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/...oncepts/parallel-testing-in-nightwatch.md → ...oncepts/parallel-testing-in-nightwatch.md b/...oncepts/parallel-testing-in-nightwatch.md → ...oncepts/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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/guide/concepts/session-capabilities.md → docs/guide/concepts/session-capabilities.md b/guide/concepts/session-capabilities.md → docs/guide/concepts/session-capabilities.md
diff --git a/guide/concepts/test-environments.md → docs/guide/concepts/test-environments.md b/guide/concepts/test-environments.md → docs/guide/concepts/test-environments.md
diff --git a/guide/concepts/test-globals.md → docs/guide/concepts/test-globals.md b/guide/concepts/test-globals.md → 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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/guide/concepts/what-is-end-to-end-testing.md → ...de/concepts/what-is-end-to-end-testing.md b/guide/concepts/what-is-end-to-end-testing.md → ...de/concepts/what-is-end-to-end-testing.md
diff --git a/...uration/advanced-test-source-filtering.md → ...uration/advanced-test-source-filtering.md b/...uration/advanced-test-source-filtering.md → ...uration/advanced-test-source-filtering.md
@@ -56,8 +56,8 @@ The below settings can be used to define ways of filtering test files.
 </table>
 
 ### 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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/.../configuration/aws-devicefarm-settings.md → .../configuration/aws-devicefarm-settings.md b/.../configuration/aws-devicefarm-settings.md → .../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: [],
    <br>
-   // 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/'],
    <br>
-   // 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/'],
    <br>
-   // See https://nightwatchjs.org/guide/extending-nightwatch/custom-assertions.html
+   // See /guide/extending-nightwatch/custom-assertions.html
    custom_assertions_path: '',
    <br>
-   // See https://nightwatchjs.org/guide/extending-nightwatch/plugin-api.html
+   // See /guide/extending-nightwatch/plugin-api.html
    plugins: [],
    <br>
-   // See https://nightwatchjs.org/guide/#external-globals
+   // See /guide/#external-globals
    globals_path : '',
    <br>
    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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/...e/configuration/browser-stack-settings.md → ...e/configuration/browser-stack-settings.md b/...e/configuration/browser-stack-settings.md → ...e/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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/.../configuration/customising-test-output.md → .../configuration/customising-test-output.md b/.../configuration/customising-test-output.md → .../configuration/customising-test-output.md
@@ -90,8 +90,8 @@ The below settings can be used to control the output and logging when running te
 </table>
 
 ### 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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/...configuration/define-test-environments.md → ...configuration/define-test-environments.md b/...configuration/define-test-environments.md → ...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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/...configuration/enabling-http-keep-alive.md → ...configuration/enabling-http-keep-alive.md b/...configuration/enabling-http-keep-alive.md → ...configuration/enabling-http-keep-alive.md
diff --git a/...guration/nightwatch-configuration-file.md → ...guration/nightwatch-configuration-file.md b/...guration/nightwatch-configuration-file.md → ...guration/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.
 
 <div class="alert alert-info">
 From Nightwatch 2, you can also specify the config file to return a Promise and the result will be <code>await</code>-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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">

diff --git a/guide/configuration/overview.md → docs/guide/configuration/overview.md b/guide/configuration/overview.md → docs/guide/configuration/overview.md
@@ -104,7 +104,7 @@ Considering this setup, to run tests, for instance, against Safari, we would run
 
 <pre><code class="language-bash">nightwatch --env safari</code></pre>
 
-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
 };</code></pre>
 </div>
 
-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)
+- [Reference > All configuration settings](/guide/reference/settings.html)
+- [Reference > Configuration defaults](/guide/reference/defaults.html)
diff --git a/guide/configuration/selenium-settings.md → .../guide/configuration/selenium-settings.md b/guide/configuration/selenium-settings.md → .../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)
 
  <div class="doc-pagination pt-40">
   <div class="previous">