docs: Re-build doc

adrien2p · Feb 14, 2022 · 56af3a5 · 56af3a5
1 parent ad977cf
commit 56af3a5
Show file tree

Hide file tree

Showing 31 changed files with 115 additions and 93 deletions.
diff --git a/.github/docs/index.html b/.github/docs/index.html
@@ -8,6 +8,16 @@
     <meta content="width=device-width,initial-scale=1" name="viewport">
     <meta charset="UTF-8">
 
+    <meta content="Medusa-extender" property="og:title"/>
+    <meta content="website" property="og:type"/>
+    <meta content="https://adrien2p.github.io/medusa-extender/#/" property="og:url"/>
+    <meta content="https://github.com/adrien2p/medusa-extender/blob/assets/assets/logo.png?raw=true"
+          property="og:image"/>
+    <meta content="Do you want to extend existing entities to add custom fields? Do you want to implement your own feature or extend existing one in a module way? Did you ever wanted to build something more than a single store? Well, this project has been made to help you reach you goal. It is now possible to customise Medusa in a way you will be able to enjoy all the awesome features that Medusa provides you but with the possibility to take your e-commerce project to the next level 🚀"
+          name="og:description">
+    <meta content="summary_large_image" name="twitter:card">
+
+    <link href="https://github.com/adrien2p/medusa-extender/blob/assets/assets/logo.png?raw=true" rel="icon" type="image/x-icon">
     <link href="https://cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" rel="stylesheet"/>
 </head>
 <body>
@@ -17,7 +27,7 @@
 	window.$docsify = {
 		el: "#main",
 		repo: 'https://github.com/adrien2p/medusa-extender',
-        themeColor: '#793ef9',
+		themeColor: '#793ef9',
 		search: {
 			maxAge: 86400000, // Expiration time, the default one day
 			paths: 'auto', // or 'auto'

diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@
 <div align="center">
   <a href="https://github.com/adrien2p/awesome-medusajs"><img src="https://awesome.re/badge.svg" alt="Awesome"></a>
   <a href="https://www.npmjs.com/package/medusa-extender"><img src="https://badge.fury.io/js/medusa-extender.svg" alt="npm version" height="18"></a>
+  <a href="https://img.shields.io/npm/dt/medusa-extender"><img src="https://img.shields.io/npm/dt/medusa-extender" alt="npm download" height="18"></a>
   <a href="https://github.com/adrien2p/medusa-extender/commits/main"><img src="https://img.shields.io/github/commit-activity/m/adrien2p/medusa-extender?style=flat-square" alt="activity" height="18"></a>
   <a href="https://github.com/adrien2p/medusa-extender/issues"><img src="https://img.shields.io/github/issues/adrien2p/medusa-extender?style=flat-square" alt="issues" height="18"></a>
   <a href="https://www.npmjs.com/package/medusa-extender"><img src="https://img.shields.io/npm/dm/medusa-extender?style=flat-square" alt="download" height="18"></a>

diff --git a/docs/README.md b/docs/README.md
@@ -23,6 +23,7 @@ medusa-extender / [Exports](modules.md)
 <div align="center">
   <a href="https://github.com/adrien2p/awesome-medusajs"><img src="https://awesome.re/badge.svg" alt="Awesome"></a>
   <a href="https://www.npmjs.com/package/medusa-extender"><img src="https://badge.fury.io/js/medusa-extender.svg" alt="npm version" height="18"></a>
+  <a href="https://img.shields.io/npm/dt/medusa-extender"><img src="https://img.shields.io/npm/dt/medusa-extender" alt="npm download" height="18"></a>
   <a href="https://github.com/adrien2p/medusa-extender/commits/main"><img src="https://img.shields.io/github/commit-activity/m/adrien2p/medusa-extender?style=flat-square" alt="activity" height="18"></a>
   <a href="https://github.com/adrien2p/medusa-extender/issues"><img src="https://img.shields.io/github/issues/adrien2p/medusa-extender?style=flat-square" alt="issues" height="18"></a>
   <a href="https://www.npmjs.com/package/medusa-extender"><img src="https://img.shields.io/npm/dm/medusa-extender?style=flat-square" alt="download" height="18"></a>

diff --git a/docs/classes/Medusa.Medusa-1.md b/docs/classes/Medusa.Medusa-1.md
@@ -37,7 +37,7 @@ internal container and database connection.
 
 #### Defined in
 
-[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L37)
+[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L37)
 
 ## Properties
 
@@ -47,7 +47,7 @@ internal container and database connection.
 
 #### Defined in
 
-[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L30)
+[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L30)
 
 ___
 
@@ -57,7 +57,7 @@ ___
 
 #### Defined in
 
-[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L31)
+[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L31)
 
 ## Methods
 
@@ -77,4 +77,4 @@ ___
 
 #### Defined in
 
-[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L45)
+[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L45)
diff --git a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md b/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md
@@ -45,7 +45,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
+[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
 
 ## Properties
 
@@ -55,7 +55,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
+[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
+[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
 
 ## Accessors
 
@@ -79,7 +79,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
+[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
 
 ___
 
@@ -93,7 +93,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
+[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
 
 ## Methods
 
@@ -120,7 +120,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
+[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
 
 ___
 
@@ -146,7 +146,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
+[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
 
 ___
 
@@ -173,7 +173,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
+[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
 
 ___
 
@@ -199,7 +199,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
+[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
 
 ___
 
@@ -226,7 +226,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
+[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
 
 ___
 
@@ -252,7 +252,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
+[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
 
 ___
 
@@ -280,7 +280,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
+[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
 
 ___
 
@@ -300,4 +300,4 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
+[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
diff --git a/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md b/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md
@@ -41,7 +41,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L21)
+[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/event-emmiter.ts#L21)
 
 ## Properties
 
@@ -51,7 +51,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L19)
+[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/event-emmiter.ts#L19)
 
 ## Methods
 
@@ -80,7 +80,7 @@ Emit an asynchrone event entity based and wait for the result.
 
 #### Defined in
 
-[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L80)
+[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/event-emmiter.ts#L80)
 
 ___
 
@@ -110,7 +110,7 @@ Register a new event handler.
 
 #### Defined in
 
-[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L31)
+[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/event-emmiter.ts#L31)
 
 ___
 
@@ -132,7 +132,7 @@ Apply all event handlers hold by the `listenerDescriptor`.
 
 #### Defined in
 
-[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L43)
+[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/event-emmiter.ts#L43)
 
 ___
 
@@ -146,4 +146,4 @@ ___
 
 #### Defined in
 
-[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L68)
+[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/event-emmiter.ts#L68)
diff --git a/docs/classes/metadata_reader.Internals.CustomMap.md b/docs/classes/metadata_reader.Internals.CustomMap.md
@@ -84,4 +84,4 @@ Map.get
 
 #### Defined in
 
-[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/metadata-reader.ts#L5)
+[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/metadata-reader.ts#L5)
diff --git a/docs/classes/utils.Utils.md b/docs/classes/utils.Utils.md
@@ -56,7 +56,7 @@ Attach a new subscriber to a specific entities.
 
 #### Defined in
 
-[src/utils.ts:37](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L37)
+[src/utils.ts:37](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L37)
 
 ___
 
@@ -80,7 +80,7 @@ Prepare the log to be shown to be consistent everywhere.
 
 #### Defined in
 
-[src/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L68)
+[src/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L68)
 
 ___
 
@@ -102,7 +102,7 @@ Log all the routes from the express instance.
 
 #### Defined in
 
-[src/utils.ts:58](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L58)
+[src/utils.ts:58](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L58)
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-[src/utils.ts:82](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L82)
+[src/utils.ts:82](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L82)
 
 ___
 
@@ -153,7 +153,7 @@ Since it is not possible to use multiple extend, you can use that utilities to a
 
 #### Defined in
 
-[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L17)
+[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L17)
 
 ___
 
@@ -173,4 +173,4 @@ ___
 
 #### Defined in
 
-[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L102)
+[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L102)
diff --git a/docs/index.html b/docs/index.html
@@ -8,6 +8,16 @@
     <meta content="width=device-width,initial-scale=1" name="viewport">
     <meta charset="UTF-8">
 
+    <meta content="Medusa-extender" property="og:title"/>
+    <meta content="website" property="og:type"/>
+    <meta content="https://adrien2p.github.io/medusa-extender/#/" property="og:url"/>
+    <meta content="https://github.com/adrien2p/medusa-extender/blob/assets/assets/logo.png?raw=true"
+          property="og:image"/>
+    <meta content="Do you want to extend existing entities to add custom fields? Do you want to implement your own feature or extend existing one in a module way? Did you ever wanted to build something more than a single store? Well, this project has been made to help you reach you goal. It is now possible to customise Medusa in a way you will be able to enjoy all the awesome features that Medusa provides you but with the possibility to take your e-commerce project to the next level 🚀"
+          name="og:description">
+    <meta content="summary_large_image" name="twitter:card">
+
+    <link href="https://github.com/adrien2p/medusa-extender/blob/assets/assets/logo.png?raw=true" rel="icon" type="image/x-icon">
     <link href="https://cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" rel="stylesheet"/>
 </head>
 <body>
@@ -17,7 +27,7 @@
 	window.$docsify = {
 		el: "#main",
 		repo: 'https://github.com/adrien2p/medusa-extender',
-        themeColor: '#793ef9',
+		themeColor: '#793ef9',
 		search: {
 			maxAge: 86400000, // Expiration time, the default one day
 			paths: 'auto', // or 'auto'

diff --git a/docs/interfaces/types.MedusaMiddleware.md b/docs/interfaces/types.MedusaMiddleware.md
@@ -33,4 +33,4 @@ Describe a custom middleware instance.
 
 #### Defined in
 
-[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/types.ts#L152)
+[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/types.ts#L152)
diff --git a/docs/interfaces/types.Type.md b/docs/interfaces/types.Type.md
@@ -40,4 +40,4 @@ Function.constructor
 
 #### Defined in
 
-[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/types.ts#L6)
+[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/types.ts#L6)
diff --git a/docs/modules/constants.md b/docs/modules/constants.md
@@ -20,7 +20,7 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/constants.ts#L9)
+[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/constants.ts#L9)
 
 ___
 
@@ -66,7 +66,7 @@ Hold the name of the medusa services registered into the container for later on
 
 #### Defined in
 
-[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/constants.ts#L14)
+[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/constants.ts#L14)
 
 ___
 
@@ -78,4 +78,4 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/constants.ts#L4)
+[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/constants.ts#L4)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -84,4 +84,4 @@ Map.get

		#### Defined in

		[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/metadata-reader.ts#L5)
		[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/metadata-reader.ts#L5)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,4 +33,4 @@ Describe a custom middleware instance.

		#### Defined in

		[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/types.ts#L152)
		[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/types.ts#L152)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,4 +40,4 @@ Function.constructor

		#### Defined in

		[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/types.ts#L6)
		[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/types.ts#L6)