3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 08:49:51 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): add disableVersioning config to docs plugin (#2989)

Browse source 
* add disableVersioning config to docs plugin

* fix test

* fix test
This commit is contained in:
Sébastien Lorber 2020-07-01 19:03:59 +02:00 • committed by GitHub
parent 9265de982b
commit a5b2b6056b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 44 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -96,12 +96,16 @@ module.exports = {
Then in the folder `my-plugin` you can create an index.js such as this
```js title="index.js"
module.exports = function(context, options) {
module.exports = function (context, options) {
// ...
return {
name: 'my-docusaurus-plugin',
async loadContent() { ... },
async contentLoaded({content, actions}) { ... },
async loadContent() {
/* ... */
},
async contentLoaded({content, actions}) {
/* ... */
},
/* other lifecycle API */
};
};
@ -113,7 +117,7 @@ The `my-plugin` folder could also be a fully fledged package with it's own packa
`context` is plugin-agnostic and the same object will be passed into all plugins used for a Docusaurus website. The `context` object contains the following fields:
```js
```ts
interface LoadContext {
siteDir: string;
generatedFilesDir: string;
@ -288,6 +292,11 @@ module.exports = {
* Whether to display the last date the doc was updated.
*/
showLastUpdateTime: false,
/**
* By default, versioning is enabled on versioned sites.
* This is a way to explicitly disable the versioning feature.
*/
disableVersioning: false,
/**
* Skip the next release docs when versioning is enabled.
* This will not generate HTML files in the production build for documents