Docusaurus Sylk Plugin

This is the main plugin interfaced for sylk autogenerated documentation based on sylk.json file.
It is meant to use with running instance of Docusaurus

Installation

Install via [npm]()

``bash
npm install @sylk/docusaurus-sylk
`

Setup

First you'll need to configure the presets of docusaurus-sylk plugin.
Navigate to docusaurus.config.js and place the Sylk's plugin presets:

`js
const config = {
presets: [
[
'docusaurus-sylk',
{
sylk: {
sylkJsonPaths: [
'./sylk/Todo-App/sylk.json',
'./sylk/sylk-core/sylk.json'
],
sylkDocsPath: './sylk',
},
docs: {
routeBasePath: 'sylk',
sidebarPath: './sidebarsSylk.js',
}
}
],
// ... More Presets ...
]
// ... More Configurations ...
}
`

1. Create a root directory for your Sylk's documentation projects inside of docusaurus root directory.
2. To keep things clear keep for any project a unique directory hierarchy inside the sylk root directory created in step 1.
3. Place the sylk.json file of your project at sylk//sylk.json
4. Next

Usage

The plugin extending the core docusaurus CLI and by invoking the command you can generate the docs based on your sylk.json files.
`bash
npx docusaurus generate-sylk-docs
`

---
This plugin created with ❤️ by Sylk Team`