@gasket/plugin-docusaurus NPM | npm.io

7.0.6 • Published 10 months ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

10 months ago

@gasket/plugin-docusaurus

Use Docusaurus to serve a website view of the collated docs from @gasket/plugin-docs.

Installation

npm i @gasket/plugin-docs @gasket/plugin-docusaurus

Update your gasket file plugin configuration:

// gasket.js

+ import pluginDocusarus from '@gasket/plugin-docusaurus';
+ import pluginDocs from '@gasket/plugin-docs';

export default makeGasket({
  plugins: [
+   pluginDocs
+   pluginDocusarus
  ]
});

Now, when you run npx gasket docs in your app, a nice Docusaurus website will be launched in your browser.

Configuration

To be set under docusaurus in the gasket.js.

rootDir - (string) Root Docusaurus directory. Default is .docs.
docsDir - (string) Sub-directory for the generated markdown from the docs plugin. Default is docs.
port - (number) Port to serve the docs from. Default is 3000.
host - (string) Hostname to serve the docs from. Default is localhost.

Example

// gasket.js

 export default makeGasket({
  docusaurus: {
    rootDir: 'my-site-documents',
    docsDir: 'markdown',
    port: 8000,
    host: 'custom-host'
  }
});

// structure
gasket-app/ // app root
|_ my-site-documents // docusaurus root
  |_ .docusaurus // build folder
  |_ markdown // generated docs from @gasket/plugin-docs

`docusaurus.config.js`

A required docusaurus.config.js will generated in the root directory if one is not present. Docusaurus allows for additional configuration/customization options and you can define those directly in the docusaurus.config.js.

License

docs viewer gasket plugin

lodash.defaultsdeep

@infinitebrahmanuniverse/nolb-_gas @everything-registry/sub-chunk-352 @zalastax/nolb-_gas create-gasket-app

10 months ago

11 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

7.0.0-7.0.1-canary.11.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

7.2.0-canary.20

1 year ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

7.0.0--canary-1.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

7.0.1-canary.12

1 year ago

7.0.1-canary.11

1 year ago

1 year ago

7.0.1-canary.10

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

6.46.1-7.0.0-cli.6.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

6.43.2-canary-esm-port.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.23.1-canary.1

3 years ago

6.23.1-canary.0

3 years ago

3 years ago

6.23.0-canary.0

3 years ago

3 years ago

6.21.0-canary.5

3 years ago

6.21.0-canary.4

3 years ago

6.21.0-canary.3

3 years ago

6.21.0-canary.2

3 years ago

6.21.0-canary.1

3 years ago

6.21.0-canary.0

3 years ago