@gasket/plugin-docusaurus
v7.0.6
Published
Gasket plugin for docusaurus
Downloads
466
Readme
@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 isdocs
.port
- (number) Port to serve the docs from. Default is3000
.host
- (string) Hostname to serve the docs from. Default islocalhost
.
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
.