https://github.com/rdilweb/template-docusaurus-plugin

Docusaurus plugin template.
https://github.com/rdilweb/template-docusaurus-plugin

Last synced: 9 months ago
JSON representation

Docusaurus plugin template.

• Host: GitHub
• URL: https://github.com/rdilweb/template-docusaurus-plugin
• Owner: rdilweb
• License: unlicense
• Created: 2021-01-14T16:03:28.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-07-06T15:55:40.000Z (almost 4 years ago)
• Last Synced: 2025-06-17T11:09:52.878Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 958 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# template-docusaurus-plugin

A Docusaurus plugin template.

## Alright, how do I use this?

It isn't really that hard. Follow these simple steps!:

1. Make a new repository using this template.

2. Clone that repository locally using your IDE of choice.

3. Edit `src/index.ts`.

4. Run `yarn build`.

5. Open a second terminal, and make the working directory the `testsite`.

6. Start the test site.

7. You now have the test site running your plugin.

When you update the plugin, in order to preview your changes on the test site, you need to:

1. Use the first shell you opened to re-run `yarn build` (in the repository's _root_ directory).

2. In the second shell, `Control+C` (or `Command+C` on macOS) the running Docusaurus dev server, and re-run `yarn start`.