@vpalmisano/typedoc-cookie-consent
v0.0.4
Published
A TypeDoc plugin to add a cookie consent banner to your documentation.
Downloads
17
Maintainers
Readme
typedoc-cookie-consent plugin
This plugin adds a cookie consent to the generated documentation powered by https://cookieconsent.orestbida.com, allowing users to accept or decline cookies used by the documentation site.
Installation
npm install --save-dev @vpalmisano/typedoc-cookie-consentOptions
Example usage with the typedoc-plugin-ga plugin:
"typedocOptions": {
"plugin": [
"typedoc-plugin-ga",
"@vpalmisano/typedoc-cookie-consent"
],
"gaID": "UA-XXXXXXXXX-X",
"gaProperties": {
"type": "text/plain",
"data-category": "analytics"
},
"cookieConsent": {
"enabled": true,
"showPreferencesBtn": true,
"config": {
// A valid cookie consent configuration (https://cookieconsent.orestbida.com/reference/configuration-reference.html)
}
}
}