Introducing the plugin starter

docusaurus-plugin-starter is the repo I wanted before building my first Docusaurus plugin.

It includes a typed plugin skeleton, lifecycle hookslifecycle hookOne of Docusaurus's plugin API methods (loadContent, contentLoaded, postBuild, …) invoked during the build., client modulesclient moduleA JS/TS file registered via a plugin's getClientModules() that runs on every client-side navigation in the browser., a swizzlable theme component, a remarkremarkA markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX. transform, tests, build scripts, and a small Docusaurus site for trying the whole thing locally. The examples are there to be cut apart. Rename the project, remove what you don't need, and keep the plumbing that would otherwise consume the first half-day.

The starter is a template rather than a runtime dependency, so it isn't registered on this site or published as a public npm package. The documentation uses a packaged archive to keep its examples reproducible.

Read the starter docs or browse the repository.