chore: add markdown link check (#141)

Author: legendecas

README.md

@@ -32,8 +32,6 @@
 # OpenTelemetry API for JavaScript
 
 [![NPM Published Version][npm-img]][npm-url]
-[![dependencies][dependencies-image]][dependencies-url]
-[![devDependencies][devDependencies-image]][devDependencies-url]
 
 This package provides everything needed to interact with the OpenTelemetry API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser.
 
@@ -136,10 +134,6 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
 [license-url]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE
 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
-[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg
-[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api
-[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg?type=dev
-[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api?type=dev
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/api
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg
 [docs-tracing]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/tracing.md

docs/tracing.md

@@ -33,9 +33,9 @@ const tracer = trace.getTracer("my-application", "0.1.0");
 
 ## Starting and Ending a Span
 
-In OpenTelemetry, all _traces_ are composed of [`Spans`](https://open-telemetry.github.io/opentelemetry-js/interfaces/span.html). A span describes a single operation with a start time and and end time like a database request, outgoing remote request, or a function invocation. These spans are linked together by parent-child relationships to form a tree. The resultant tree is your trace, and the root of the tree is commonly called the _root span_.
+In OpenTelemetry, all _traces_ are composed of [`Spans`](https://open-telemetry.github.io/opentelemetry-js-api/interfaces/span.html). A span describes a single operation with a start time and and end time like a database request, outgoing remote request, or a function invocation. These spans are linked together by parent-child relationships to form a tree. The resultant tree is your trace, and the root of the tree is commonly called the _root span_.
 
-You can create a span by calling [`Tracer#startSpan`](https://open-telemetry.github.io/opentelemetry-js/interfaces/tracer.html#startspan). The only required argument to `startSpan` is the _span name_, which should describe the operation being performed with low cardinality.
+You can create a span by calling [`Tracer#startSpan`](https://open-telemetry.github.io/opentelemetry-js-api/interfaces/tracer.html#startspan). The only required argument to `startSpan` is the _span name_, which should describe the operation being performed with low cardinality.
 
 ```typescript
 const span = tracer.startSpan("my-span-name");
@@ -102,18 +102,18 @@ async function onGet(request, response) {
 
   // Create a new context from the current context which has the span "active"
   const ctx = trace.setSpan(context.active(), span);
-  
+
   // Call getUser with the newly created context
-  // 
+  //
   // context.with calls a function with an associated "active" context. Within
   // the function, calling context.active() returns the currently active context.
   // If there is no active context, the ROOT_CONTEXT will be returned, which
   // has no key-value pairs.
-  // 
+  //
   // context.with requires at least 2 arguments: a context and a function to be called.
   // If a third argument is provided, it will be bound to `this` `this` inside the function.
   // Any additional parameters are used as arguments when calling the function.
-  // 
+  //
   //   Return value is the value returned from getUser
   //    |                         Context to be used as the "active" context
   //    |                         |    Function to be called

package.json

@@ -19,7 +19,7 @@
     "compile": "tsc --build tsconfig.json tsconfig.esm.json",
     "docs": "typedoc",
     "docs:deploy": "gh-pages --dist docs/out",
-    "docs:test": "linkinator docs/out --silent --skip david-dm.org",
+    "docs:test": "linkinator docs/out --silent && linkinator docs/*.md *.md --markdown --silent",
     "lint:fix": "eslint src test --ext .ts --fix",
     "lint": "eslint src test --ext .ts",
     "test:browser": "nyc karma start --single-run",

tsconfig.json

@@ -33,6 +33,7 @@
     "name": "OpenTelemetry API for JavaScript",
     "out": "docs/out",
     "entryPoints": ["./src/index.ts"],
+    "excludePrivate": true,
     "hideGenerator": true
   }
 }