diff --git a/docs/quick-start.md b/docs/quick-start.md index 6b39c6cf9..0fa0706ad 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -43,7 +43,7 @@ which may not be in the preset. For example, if you want the `gasket docs` command in the app, you could specify the additional plugins as: ```bash -gasket create your-app-name --presets @gasket/nextjs --plugins @gasket/docs,@gasket/docsify +gasket create your-app-name --presets @gasket/nextjs --plugins @gasket/docs,@gasket/docusaurus ``` Notice also, that you can use [short-hand names] for presets and plugins here. @@ -54,7 +54,7 @@ If you have an existing app, some plugins can be added after create. First, install the necessary node modules: ```bash -npm i @gasket/plugin-docs @gasket/plugin-docsify +npm i @gasket/plugin-docs @gasket/plugin-docusaurus ``` Then, in the app's `gasket.config.js`, add the plugins: @@ -67,7 +67,7 @@ module.exports = { + ], + add: [ + '@gasket/docs', -+ '@gasket/docsify' ++ '@gasket/docusaurus' ] } }; diff --git a/package-lock.json b/package-lock.json index 36d011580..16e03b7ea 100644 --- a/package-lock.json +++ b/package-lock.json @@ -39418,7 +39418,7 @@ "dependencies": { "@gasket/plugin-config": "^6.45.2", "@gasket/plugin-docs": "^6.45.2", - "@gasket/plugin-docsify": "^6.45.2", + "@gasket/plugin-docusaurus": "^6.45.2", "@gasket/plugin-express": "^6.46.0", "@gasket/plugin-https": "^6.45.2", "@gasket/plugin-lint": "^6.45.2", @@ -43871,7 +43871,7 @@ "requires": { "@gasket/plugin-config": "^6.45.2", "@gasket/plugin-docs": "^6.45.2", - "@gasket/plugin-docsify": "^6.45.2", + "@gasket/plugin-docusaurus": "^6.45.2", "@gasket/plugin-express": "^6.46.0", "@gasket/plugin-https": "^6.45.2", "@gasket/plugin-lint": "^6.45.2", diff --git a/packages/gasket-plugin-docs/README.md b/packages/gasket-plugin-docs/README.md index 8a364d11d..268fa8a7c 100644 --- a/packages/gasket-plugin-docs/README.md +++ b/packages/gasket-plugin-docs/README.md @@ -172,7 +172,7 @@ module.exports = { } ``` -The [@gasket/plugin-docsify] hooks this lifecycle, to render the docs using +The [@gasket/plugin-docusaurus] hooks this lifecycle, to render the docs using Docsify. ### 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-preset-api/README.md b/packages/gasket-preset-api/README.md index 2e7df3cd1..730562634 100644 --- 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 index 5517372c7..56484d0c6 100644 --- 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 index f96a5d2ce..298490239 100644 --- a/packages/gasket-preset-api/package.json +++ b/packages/gasket-preset-api/package.json @@ -22,7 +22,7 @@ "dependencies": { "@gasket/plugin-config": "^6.45.2", "@gasket/plugin-docs": "^6.45.2", - "@gasket/plugin-docsify": "^6.45.2", + "@gasket/plugin-docusaurus": "^6.45.2", "@gasket/plugin-express": "^6.46.0", "@gasket/plugin-https": "^6.45.2", "@gasket/plugin-lint": "^6.45.2", diff --git a/packages/gasket-typescript-tests/test/plugin-docsify.spec.ts b/packages/gasket-typescript-tests/test/plugin-docsify.spec.ts deleted file mode 100644 index 38169e2c7..000000000 --- a/packages/gasket-typescript-tests/test/plugin-docsify.spec.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { GasketConfigFile } from '@gasket/engine'; -import '@gasket/plugin-docsify'; - -describe('@gasket/plugin-docsify', () => { - it('adds a docsify config section', () => { - const config: GasketConfigFile = { - docsify: { - theme: 'fancy', - port: 6234, - config: { - maxLevel: 4 - }, - stylesheets: ['./some.css', './file.css'], - scripts: ['./jquery.js', './angular.js'] - } - }; - }); -});