3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-04 12:47:14 +02:00
Code Issues Projects Releases Packages Wiki Activity

Wrap plugins in next version

Browse source
This commit is contained in:
Tom Brien 2020-06-16 10:29:38 +01:00 • committed by GitHub
parent e187af0f56
commit 5afa06e243
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
website/docs/using-plugins.md
View file

@ -18,7 +18,7 @@ Then you add it in your site's `docusaurus.config.js`'s `plugins` option:
```jsx {3} title="docusaurus.config.js" ```jsx {3} title="docusaurus.config.js"
module.exports = { module.exports = {
// ... // ...
plugins: ['@docusaurus/plugin-content-pages'], plugins: [require.resolve('@docusaurus/plugin-content-pages')],
}; };
``` ```
@ -44,7 +44,7 @@ module.exports = {
// ... // ...
plugins: [ plugins: [
[ [
'@docusaurus/plugin-xxx', require.resolve('@docusaurus/plugin-xxx'),
{ {
/* options */ /* options */
}, },
@ -63,7 +63,7 @@ module.exports = {
// With options object (babel style) // With options object (babel style)
[ [
'@docusaurus/plugin-sitemap', require.resolve('@docusaurus/plugin-sitemap'),
{ {
cacheTime: 600 * 1000, cacheTime: 600 * 1000,
}, },
@ -142,7 +142,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-content-blog', require.resolve('@docusaurus/plugin-content-blog'),
{ {
/** /**
* Path to data on filesystem relative to site dir. * Path to data on filesystem relative to site dir.
@ -226,7 +226,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-content-docs', require.resolve('@docusaurus/plugin-content-docs'),
{ {
/** /**
* Path to data on filesystem relative to site dir. * Path to data on filesystem relative to site dir.
@ -301,7 +301,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-content-pages', require.resolve('@docusaurus/plugin-content-pages'),
{ {
/** /**
* Path to data on filesystem * Path to data on filesystem
@ -341,7 +341,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
```js title="docusaurus.config.js" ```js title="docusaurus.config.js"
module.exports = { module.exports = {
plugins: ['@docusaurus/plugin-google-analytics'], plugins: [require.resolve('@docusaurus/plugin-google-analytics')],
themeConfig: { themeConfig: {
googleAnalytics: { googleAnalytics: {
trackingID: 'UA-141789564-1', trackingID: 'UA-141789564-1',
@ -372,7 +372,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
```js title="docusaurus.config.js" ```js title="docusaurus.config.js"
module.exports = { module.exports = {
plugins: ['@docusaurus/plugin-google-gtag'], plugins: [require.resolve('@docusaurus/plugin-google-gtag')],
themeConfig: { themeConfig: {
gtag: { gtag: {
trackingID: 'UA-141789564-1', trackingID: 'UA-141789564-1',
@ -403,7 +403,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-sitemap', require.resolve('@docusaurus/plugin-sitemap'),
{ {
cacheTime: 600 * 1000, // 600 sec - cache purge period cacheTime: 600 * 1000, // 600 sec - cache purge period
changefreq: 'weekly', changefreq: 'weekly',
@ -427,7 +427,7 @@ Modify your `docusaurus.config.js`
```diff ```diff
module.exports = { module.exports = {
... ...
+ plugins: ['@docusaurus/plugin-ideal-image'], + plugins: [require.resolve('@docusaurus/plugin-ideal-image')],
... ...
} }
``` ```
@ -487,7 +487,7 @@ Main usecase: you have `/myDocusaurusPage`, and you want to redirect to this pag
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-client-redirects', require.resolve('@docusaurus/plugin-client-redirects'),
{ {
fromExtensions: ['html'], fromExtensions: ['html'],
}, },
@ -502,7 +502,7 @@ Second usecase: you have `/myDocusaurusPage.html`, and you want to redirect to t
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-client-redirects', require.resolve('@docusaurus/plugin-client-redirects'),
{ {
toExtensions: ['html'], toExtensions: ['html'],
}, },
@ -519,7 +519,7 @@ Let's imagine you change the url of an existing page, you might want to make sur
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-client-redirects', require.resolve('@docusaurus/plugin-client-redirects'),
{ {
redirects: [ redirects: [
{ {
@ -539,7 +539,7 @@ It's possible to use a function to create the redirects for each existing path:
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-client-redirects', require.resolve('@docusaurus/plugin-client-redirects'),
{ {
createRedirects: function (existingPath) { createRedirects: function (existingPath) {
if (existingPath === '/docs/newDocPath') { if (existingPath === '/docs/newDocPath') {
@ -558,7 +558,7 @@ Finally, it's possible to use all options at the same time:
module.exports = { module.exports = {
plugins: [ plugins: [
[ [
'@docusaurus/plugin-client-redirects', require.resolve('@docusaurus/plugin-client-redirects'),
{ {
fromExtensions: ['html', 'htm'], fromExtensions: ['html', 'htm'],
toExtensions: ['exe', 'zip'], toExtensions: ['exe', 'zip'],