refactor: Added links to documentation in jsdoc

oyedejioyewole · Jan 4, 2024 · 7d6dd8c · 7d6dd8c
1 parent 326d4c4
commit 7d6dd8c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/docs/components/IntroBanner.vue b/docs/components/IntroBanner.vue
@@ -71,8 +71,9 @@ function generateIcons() {
       <NuxtLink
         class="flex w-full items-center justify-center gap-x-2 rounded-full border border-primary-500 p-3 text-primary-500 transition hover:bg-primary-500 hover:text-primary-900 lg:w-[200px] lg:justify-around lg:gap-x-0"
         to="/release-notes"
-        >Release Notes <LazyPhosphorIconArrowRight size="20"
-      /></NuxtLink>
+      >
+        Release Notes <LazyPhosphorIconArrowRight size="20" />
+      </NuxtLink>
     </div>
   </header>
 </template>
diff --git a/docs/content/index.md b/docs/content/index.md
@@ -29,7 +29,7 @@ Follow the following steps to start using this module:
 
 Congratulations 🎉, you can now use any icon from `@phosphor-icon/vue` in your Nuxt project!
 
-Browse the available of icons [here](https://phosphoricons.com/)
+Browse the available of icons [here.](https://phosphoricons.com/)
 
 Before hurrying on now, lets go through some possible configuration you might want to do!
 
@@ -44,7 +44,7 @@ You can configure the module using the `phosphor` key in the `nuxt.config.ts`
 #### `expose`
 
 1. **Default**: `false`
-2. **Description**: Enable to register components globally
+2. **Description**: Enable to register components globally.
 3. **Type**: `Boolean`
 
 ```ts
@@ -60,7 +60,7 @@ export default defineNuxtConfig({
 #### `prefix`
 
 1. **Default:** `phosphor-icon` or `PhosphorIcon`
-2. **Description:** The prefix of the component names
+2. **Description:** The prefix of the component names.
 3. **Type:** `String`
 
 ```ts
@@ -71,7 +71,7 @@ export default defineNuxtConfig({
 });
 ```
 
-**Note**: if you have a multi word prefix, you should include a &mdash; between the words
+**Note**: if you have a multi word prefix, you should include a &mdash; between the words.
 
 <br>
 

diff --git a/src/module.ts b/src/module.ts
@@ -14,13 +14,15 @@ export interface ModuleOptions {
    * Enable to register components globally
    *
    * @default false
+   * @link https://nuxt-phosphor-icons.vercel.app#expose
    */
   expose: boolean;
 
   /**
    * The prefix of the component names
    *
    * @default "phosphor-icon" or "PhosphorIcon"
+   * @link https://nuxt-phosphor-icons.vercel.app#prefix
    */
   prefix: string;
 
@@ -29,6 +31,7 @@ export interface ModuleOptions {
    * of registered components at `#build/nuxt-phosphor-icons.json`
    *
    * @default false
+   * @link https://nuxt-phosphor-icons.vercel.app#showlist
    */
   showList: boolean;
 }