Fix links in "W3C Webdriver Spec" section of the API docs (#294)

nightwatchjs · Apr 1, 2024 · f9050ac · f9050ac
1 parent a93ecd7
commit f9050ac
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/postdoc.config.js b/postdoc.config.js
@@ -6,7 +6,8 @@ const {
   BASE_URL = 'https://nightwatchjs.org',
   MD_DOCS_FOLDER =  './docs',
   API_DOCS_FOLDER = resolve('../nightwatch/lib/api'),
-  EXAMPLES_FOLDER = 'node_modules/nightwatch-examples/tests'
+  EXAMPLES_FOLDER = 'node_modules/nightwatch-examples/tests',
+  WEBDRIVER_SPEC_URL = 'https://w3c.github.io/webdriver',
 } = env;
 
 export default {
@@ -87,6 +88,7 @@ export default {
   appSettings: {
     version: NIGHTWATCH_VERSION,
     baseUrl: BASE_URL,
+    webdriverSpecUrl : WEBDRIVER_SPEC_URL,
     apiRepoUrl: 'https://github.com',
     githubRepo: 'nightwatchjs/nightwatch',
     docsRepoUrl: 'https://github.com/nightwatchjs/nightwatch-docs/blob/',
@@ -102,4 +104,4 @@ export default {
   logger: {
     quiet: false
   }
-};
+};
diff --git a/src/includes/api-method.ejs b/src/includes/api-method.ejs
@@ -142,8 +142,12 @@ npx nightwatch <%- method.exampleLink %></code></pre>
 
     <% if (method.link) { %>
         <h3>W3C WebDriver spec</h3>
-        <ul>
-            <li><code><a href="<%= method.link %>" target="_blank"><%- method.link %></a></code></li>
+        <ul class="webdriver-spec-link">
+            <% if (method.link.startsWith('http')) { %>
+                <li><code><a href="<%- method.link %>" target="_blank"><%= method.link %></a></code></li>
+            <% } else { %>
+                <li><code><a href="<%- appSettings.webdriverSpecUrl + method.link %>" target="_blank"><%= method.link %></a></code></li>
+            <% } %>            
         </ul>
     <% } %>
 <% } %>