https://github.com/webbertakken/docusaurus-plugin-content-tools
An easy way to index and route tools on your docusaurus page.
https://github.com/webbertakken/docusaurus-plugin-content-tools
Last synced: about 1 year ago
JSON representation
An easy way to index and route tools on your docusaurus page.
- Host: GitHub
- URL: https://github.com/webbertakken/docusaurus-plugin-content-tools
- Owner: webbertakken
- License: mit
- Created: 2022-07-11T22:46:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-11T23:05:24.000Z (almost 4 years ago)
- Last Synced: 2025-03-07T12:36:27.002Z (over 1 year ago)
- Language: TypeScript
- Size: 164 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Docusaurus tools plugin
> An easy way to index and route tools on your docusaurus page.
## Introduction
You can specify one of your components folders to be your tools folder. Inside that folder you can
create 1 folder per tool, that exposes a React component through its `index.ts`. Each tool will
generate each own page. Links will be indexed on the tools main page.
See it in action on [Takken.io](https://takken.io).
## Setup
### Install dependencies
Choose one:
```bash
# NPM
npm install dotenv docusaurus-plugin-content-tools
# Yarn
yarn add dotenv docusaurus-plugin-content-tools
```
### Configure
#### `docusaurus.config.js`
```js
const config = {
// Configure plugin
plugins: [
[
'docusaurus-plugin-content-tools',
{
enabled: true,
verbose: true,
toolsFolder: '@site/src/components/pages/Tools',
},
],
],
// Configure navbar
themeConfig: {
navbar: {
items: [{ to: '/tools', label: 'Tools', position: 'left' }],
},
},
}
```
### Options
#### `enabled`
Whether this plugin is enabled.
_**required:** `false`_ _**default:** `true`_
#### `verbose`
Gives output about retrieving the tools during build time
_**required:** `false`_ _**default:** `false`_
#### `toolsFolder`
The folder that you mark as your tools-folder. Must begin with `@site`.
> Example: `'@site/src/components/pages/Tools'`
_**required:** `true`_ _**default:** `undefined`_
#### `toolPageComponent`
Which component to use for showing the tool page (wrapper for the tool itself).
_**required:** `false`_ _**default:** `'@theme/ToolPage'`_
#### `toolOverviewPageComponent`
Which component to use for showing the tools overview page.
_**required:** `false`_ _**default:** `'@theme/ToolOverviewPage''`_
## Contributing
Contributions are welcome!
Please read the [contributing guide](./CONTRIBUTING.md).
## License
[MIT](./LICENSE) licensed.