{"id":15748208,"url":"https://github.com/webbertakken/docusaurus-plugin-content-tools","last_synced_at":"2025-03-31T06:43:27.115Z","repository":{"id":44666437,"uuid":"512929232","full_name":"webbertakken/docusaurus-plugin-content-tools","owner":"webbertakken","description":"An easy way to index and route tools on your docusaurus page.","archived":false,"fork":false,"pushed_at":"2022-07-11T23:05:24.000Z","size":168,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-07T12:36:27.002Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webbertakken.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-11T22:46:56.000Z","updated_at":"2022-07-11T23:22:27.000Z","dependencies_parsed_at":"2022-09-26T21:21:49.428Z","dependency_job_id":null,"html_url":"https://github.com/webbertakken/docusaurus-plugin-content-tools","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webbertakken","download_url":"https://codeload.github.com/webbertakken/docusaurus-plugin-content-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246429447,"owners_count":20775805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-04T05:40:54.247Z","updated_at":"2025-03-31T06:43:27.076Z","avatar_url":"https://github.com/webbertakken.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docusaurus tools plugin\n\n\u003e An easy way to index and route tools on your docusaurus page.\n\n## Introduction\n\nYou can specify one of your components folders to be your tools folder. Inside that folder you can\ncreate 1 folder per tool, that exposes a React component through its `index.ts`. Each tool will\ngenerate each own page. Links will be indexed on the tools main page.\n\nSee it in action on [Takken.io](https://takken.io).\n\n## Setup\n\n### Install dependencies\n\nChoose one:\n\n```bash\n# NPM\nnpm install dotenv docusaurus-plugin-content-tools\n\n# Yarn\nyarn add dotenv docusaurus-plugin-content-tools\n```\n\n### Configure\n\n#### `docusaurus.config.js`\n\n```js\nconst config = {\n  // Configure plugin\n  plugins: [\n    [\n      'docusaurus-plugin-content-tools',\n      {\n        enabled: true,\n        verbose: true,\n        toolsFolder: '@site/src/components/pages/Tools',\n      },\n    ],\n  ],\n\n  // Configure navbar\n  themeConfig: {\n    navbar: {\n      items: [{ to: '/tools', label: 'Tools', position: 'left' }],\n    },\n  },\n}\n```\n\n### Options\n\n#### `enabled`\n\nWhether this plugin is enabled.\n\n_**required:** `false`_ _**default:** `true`_\n\n#### `verbose`\n\nGives output about retrieving the tools during build time\n\n_**required:** `false`_ _**default:** `false`_\n\n#### `toolsFolder`\n\nThe folder that you mark as your tools-folder. Must begin with `@site`.\n\n\u003e Example: `'@site/src/components/pages/Tools'`\n\n_**required:** `true`_ _**default:** `undefined`_\n\n#### `toolPageComponent`\n\nWhich component to use for showing the tool page (wrapper for the tool itself).\n\n_**required:** `false`_ _**default:** `'@theme/ToolPage'`_\n\n#### `toolOverviewPageComponent`\n\nWhich component to use for showing the tools overview page.\n\n_**required:** `false`_ _**default:** `'@theme/ToolOverviewPage''`_\n\n## Contributing\n\nContributions are welcome!\n\nPlease read the [contributing guide](./CONTRIBUTING.md).\n\n## License\n\n[MIT](./LICENSE) licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbertakken%2Fdocusaurus-plugin-content-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebbertakken%2Fdocusaurus-plugin-content-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbertakken%2Fdocusaurus-plugin-content-tools/lists"}