3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-24 22:46:57 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat: async plugin creator functions (#6166)

Browse source
This commit is contained in:
Sébastien Lorber 2021-12-22 19:10:49 +01:00 • committed by GitHub
parent f8a670966e
commit b393700a61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 90 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

4
website/docs/api/plugin-methods/README.md
View file

@ -17,7 +17,7 @@ Every plugin is imported as a module. The module is expected to have the followi
## Plugin constructor
The plugin module's default export is a constructor function with the signature `(context: LoadContext, options: PluginOptions) => Plugin`.
The plugin module's default export is a constructor function with the signature `(context: LoadContext, options: PluginOptions) => Plugin | Promise<Plugin>`.
### `context` {#context}
@ -47,7 +47,7 @@ Here's a mind model for a presumptuous plugin implementation.
// A JavaScript function that returns an object.
// `context` is provided by Docusaurus. Example: siteConfig can be accessed from context.
// `opts` is the user-defined options.
function myPlugin(context, opts) {
async function myPlugin(context, opts) {
return {
// A compulsory field used as the namespace for directories to cache
// the intermediate data for each plugin.