[PFX-406] - Deprecate Docsify (#648)

* deprecate docsify * update docs * fix dep
godaddy · Jan 5, 2024 · 0bddca7 · 0bddca7
1 parent 252cbf9
commit 0bddca7
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 29 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/gasket-plugin-docs/README.md b/packages/gasket-plugin-docs/README.md
@@ -172,8 +172,8 @@ module.exports = {
 }
 ```
 
-The [@gasket/plugin-docsify] hooks this lifecycle, to render the docs using
-Docsify.
+The [@gasket/plugin-docusaurus] hooks this lifecycle, to render the docs using
+Docusaurus.
 
 ### docsGenerate
 
@@ -246,7 +246,7 @@ serve the content in a more viewable fashion for the user.
 [DocsTransformHandler]: docs/api.md#DocsTransformHandler
 
 [@gasket/plugin-metadata]: /packages/gasket-plugin-metadata/README.md
-[@gasket/plugin-docsify]: /packages/gasket-plugin-docsify/README.md
+[@gasket/plugin-docusaurus]: /packages/gasket-plugin-docusaurus/README.md
 [metadata]: /packages/gasket-plugin-metadata/README.md
 
 [rustdoc]:https://doc.rust-lang.org/rustdoc/

diff --git a/packages/gasket-plugin-docsify/lib/generate-content.js b/packages/gasket-plugin-docsify/lib/generate-content.js
@@ -17,6 +17,7 @@ const srcIndex = path.join(srcDir, 'index.html');
  * @param {Object} docsifyConfig - Config for docsify plugin
  * @param {DocsConfigSet} docsConfigSet -
  * @returns {Promise<string>} output file
+ * @deprecated use @gasket/plugin-docusaurus
  */
 // eslint-disable-next-line max-statements
 async function generateContent(docsifyConfig, docsConfigSet) {

diff --git a/packages/gasket-preset-api/README.md b/packages/gasket-preset-api/README.md
@@ -25,7 +25,7 @@ To see complete the list of plugins configured in your app, and what commands, l
 - [@gasket/plugin-config](/packages/gasket-plugin-config/README.md)
 - [@gasket/plugin-swagger](/packages/gasket-plugin-swagger/README.md)
 - [@gasket/plugin-docs](/packages/gasket-plugin-docs/README.md)
-- [@gasket/plugin-docsify](/packages/gasket-plugin-docsify/README.md)
+- [@gasket/plugin-docusaurus](/packages/gasket-plugin-docusaurus/README.md)
 - [@gasket/plugin-express](/packages/gasket-plugin-express/README.md)
 - [@gasket/plugin-https](/packages/gasket-plugin-https/README.md)
 - [@gasket/plugin-lint](/packages/gasket-plugin-lint/README.md)

diff --git a/packages/gasket-preset-api/lib/index.d.ts b/packages/gasket-preset-api/lib/index.d.ts
@@ -1,6 +1,6 @@
 import '@gasket/plugin-config';
 import '@gasket/plugin-docs';
-import '@gasket/plugin-docsify';
+import '@gasket/plugin-docusaurus';
 import '@gasket/plugin-express';
 import '@gasket/plugin-https';
 import '@gasket/plugin-lint';

diff --git a/packages/gasket-preset-api/package.json b/packages/gasket-preset-api/package.json
@@ -22,7 +22,7 @@
   "dependencies": {
     "@gasket/plugin-config": "^6.43.0",
     "@gasket/plugin-docs": "^6.44.1",
-    "@gasket/plugin-docsify": "^6.44.1",
+    "@gasket/plugin-docusaurus": "^6.43.0",
     "@gasket/plugin-express": "^6.44.0",
     "@gasket/plugin-https": "^6.44.0",
     "@gasket/plugin-lint": "^6.44.0",

diff --git a/packages/gasket-typescript-tests/package.json b/packages/gasket-typescript-tests/package.json
@@ -44,7 +44,7 @@
     "@gasket/plugin-command": "^6.43.0",
     "@gasket/plugin-config": "^6.43.0",
     "@gasket/plugin-docs": "^6.44.1",
-    "@gasket/plugin-docsify": "^6.44.1",
+    "@gasket/plugin-docusaurus": "^6.43.0",
     "@gasket/plugin-elastic-apm": "^6.43.0",
     "@gasket/plugin-express": "^6.44.0",
     "@gasket/plugin-https": "^6.44.0",

diff --git a/packages/gasket-typescript-tests/test/plugin-docsify.spec.ts b/packages/gasket-typescript-tests/test/plugin-docsify.spec.ts
diff --git a/packages/gasket-typescript-tests/test/plugin-docusaurus.spec.ts b/packages/gasket-typescript-tests/test/plugin-docusaurus.spec.ts
@@ -0,0 +1,15 @@
+import { GasketConfigFile } from '@gasket/engine';
+import '@gasket/plugin-docusaurus';
+
+describe('@gasket/plugin-docusaurus', () => {
+  it('adds a docusaurus config section', () => {
+    const config: GasketConfigFile = {
+      docusaurus: {
+        rootDir: 'docs',
+        docsDir: 'docs',
+        port: 3000,
+        host: 'localhost'
+      }
+    };
+  });
+});