Typedoc integrated into vitepress (#793)

Author: gossi

docs/.vitepress/config.mjs

@@ -0,0 +1,64 @@
+import { defineConfig } from "vitepress";
+
+import typedocSidebar from "../api/typedoc-sidebar.json";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "ember-link",
+  description: "Links as Primitives",
+  base: "/ember-link/",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: "Home", link: "/" },
+      { text: "Guides", link: "/getting-started" },
+      { text: "API", link: "/api/modules", activeMatch: "/api" },
+    ],
+
+    outline: [2, 3],
+
+    sidebar: {
+      "/": [
+        {
+          text: "Guides",
+          items: [
+            { text: "Getting Started", link: "/getting-started" },
+            { text: "Installation", link: "/installation" },
+            { text: "Configuration", link: "/configuration" },
+            { text: "Migration", link: "/migration" },
+          ],
+        },
+        {
+          text: "Usage",
+          items: [
+            { text: "Using Primitives", link: "/using-primitives" },
+            { text: "Params", link: "/params" },
+            { text: "Behavior", link: "/behavior" },
+            { text: "Link Helper", link: "/helper" },
+            { text: "LinkManager Service", link: "/service" },
+            { text: "Testing", link: "/testing" },
+          ],
+        },
+        {
+          text: "Advanced",
+          items: [
+            { text: "Customization", link: "/customization" },
+            { text: "Using Locales", link: "/using-locales" },
+            { text: "Link Builder", link: "/link-builder" },
+            { text: "Commands", link: "/commands" },
+          ],
+        },
+      ],
+      "/api/": [
+        {
+          text: "API",
+          items: typedocSidebar,
+        },
+      ],
+    },
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/buschtoens/ember-link" },
+    ],
+  },
+});

docs/.vitepress/config.ts

@@ -1,12 +1,12 @@
 # Behavior
 
-[`Behavior`](./api/interfaces/ember_link.Behavior.md) controls the way links are
+[`Behavior`](./api/ember-link/interfaces/Behavior.md) controls the way links are
 opened. This can be [configured globally](./configuration.md) or
 [locally with each link](./helper.md#parameters).
 
 ## `open`
 
-When links are opened with [`link.open`](./api/classes/ember_link.Link.md#open)
+When links are opened with [`link.open`](./api/ember-link/classes/Link.md#open)
 it will use
 [`Router.transitionTo()`](https://api.emberjs.com/ember/5.0/classes/RouterService/methods/transitionTo?anchor=transitionTo)
 by default, but you can set it to `replace` to use

docs/.vitepress/sidebar-api.ts

@@ -6,7 +6,7 @@ You can configure it globally or locally and there are reasons for both.
 ## Global Behavior
 
 Global configuration is happening through the
-[`LinkManagerService`](./api/classes/ember_link.LinkManagerService.md) to match
+[`LinkManagerService`](./api/ember-link/classes/LinkManagerService.md) to match
 the needs for your application:
 
 ```ts
@@ -28,7 +28,7 @@ export default class ApplicationRoute extends Route {
 
 Local behavior can be applied for each link instance and _may_ overwrite
 globally configured behavior. Pass the `behavior` parameter to a
-[`Link`](./api/classes/ember_link.Link.md) instance.
+[`Link`](./api/ember-link/classes/Link.md) instance.
 
 ## Global vs. Local Behavior
 

docs/behavior.md

@@ -1,18 +1,18 @@
 # `LinkManager` Service
 
 The `LinkManager` service is used by the [`(link) helper`](./helper.md) and
-to create a [`Link`](./api/classes/ember_link.Link.md) instances.
+to create a [`Link`](./api/ember-link/classes/Link.md) instances.
 
 You can also use this service directly to programmatically create link
 references.
 
 ## `createLink(linkParams: LinkParams): Link`
 
-Will create a [`Link`](./api/classes/ember_link.Link.md) to pass around using
+Will create a [`Link`](./api/ember-link/classes/Link.md)to pass around using
 the same parameters as [`(link) helper`](./helper.md).
 
 ::: info
-API Docs: [createLink](./api/classes/ember_link.LinkManagerService.md#createlink)
+API Docs: [createLink](./api/ember-link/classes/LinkManagerService.md#createlink)
 :::
 
 ## `getLinkParamsFromURL(url: string): LinkParams`
@@ -21,5 +21,5 @@ Use this method to derive `LinkParams` from a serialized, recognizable URL, that
 you can then pass into `createLink`.
 
 ::: info
-API Docs: [getLinkParamsFromURL](./api/classes/ember_link.LinkManagerService.md#getlinkparamsfromurl)
+API Docs: [getLinkParamsFromURL](./api/ember-link/classes/LinkManagerService.md#getlinkparamsfromurl)
 :::

docs/configuration.md

@@ -12,7 +12,7 @@ your app boots with a fully-fledged router, so `ember-link` just works normally.
 In [integration / render tests (`setupRenderingTest(hooks)`)](https://guides.emberjs.com/release/testing/testing-components/) the
 router is not initialized, so `ember-link` can't operate normally. To still
 support using `(link)` & friends in render tests, you can use the
-[`setupLink(hooks)` test helper](./api/modules/ember_link_test_support.md#setuplink).
+[`setupLink(hooks)` test helper](./api/ember-link/test-support/functions/setupLink.md).
 
 ```ts
 import { click, render } from '@ember/test-helpers';

docs/service.md

@@ -45,10 +45,10 @@ That also prepares them to properly work with [testing](./testing.md).
 
 ## Low Level Components
 
-Make [`Link`](./api/classes/ember_link.Link.md) a first-class
+Make [`Link`](./api/ember-link/classes/Link.md) a first-class
 primitive in your app architecture! Instead of manually wiring up
-[`Link#url`](./api/classes/ember_link.Link.md#url) and
-[`Link#open()`](./api/classes/ember_link.Link.md#open) every time, rather
+[`Link#url`](./api/ember-link/classes/Link.md#url) and
+[`Link#open()`](./api/ember-link/classes/Link.md#open) every time, rather
 create your own ready-to-use, style-guide-compliant link and button components
 that accept `@link` as an argument.
 

docs/testing.md

@@ -81,8 +81,9 @@
     "rollup": "4.9.6",
     "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-ts": "^3.4.5",
+    "typedoc-plugin-markdown": "^4.0.0-next.50",
+    "typedoc-vitepress-theme": "^1.0.0-next.8",
     "typedoc": "^0.25.7",
-    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.3.3"
   },
   "engines": {

docs/using-primitives.md

@@ -28,7 +28,7 @@ export default class LinkManagerService extends Service {
    */
   @service('router') readonly router!: RouterServiceWithRecognize;
 
-  [BEHAVIOR]: Behavior = {
+  protected [BEHAVIOR]: Behavior = {
     open: 'transition',
     prevent
   };

ember-link/package.json

@@ -1,16 +1,23 @@
 {
   "entryPoints": [
-    "src/index.ts",
-    "src/test-support/index.ts"
+    "./src/index.ts",
+    "./src/test-support/index.ts"
   ],
   "out": "../docs/api",
-  "json": "../docs/api/data.json",
   "plugin": [
-    "typedoc-plugin-markdown"
+    "typedoc-plugin-markdown",
+    "typedoc-vitepress-theme"
   ],
+  "docsRoot": "../docs",
+  "excludeExternals": true,
   "excludePrivate": true,
   "excludeProtected": true,
-  "excludeExternals": true,
-  // typedoc-plugin-markdown
-  "hideBreadcrumbs": true
+  "useCodeBlocks": true,
+  "parametersFormat": "table",
+  "typeDeclarationFormat": "table",
+  "textContentMappings": {
+    "breadcrumbs.home": "API",
+    "kind.typeAlias.singular": "Type",
+    "kind.typeAlias.plural": "Types",
+  }
 }

ember-link/src/services/link-manager.ts

@@ -21,8 +21,8 @@
     "docs:preview": "vitepress preview docs"
   },
   "devDependencies": {
-    "concurrently": "^7.6.0",
-    "vitepress": "^1.0.0-beta.3"
+    "concurrently": "^8.2.2",
+    "vitepress": "^1.0.0-rc.41"
   },
   "volta": {
     "node": "20.11.0"