https://github.com/davidcralph/docsify-ethicalads
EthicalAds support for Docsify
https://github.com/davidcralph/docsify-ethicalads
docsify docsify-js docsify-plugin ethicalads
Last synced: 9 months ago
JSON representation
EthicalAds support for Docsify
- Host: GitHub
- URL: https://github.com/davidcralph/docsify-ethicalads
- Owner: davidcralph
- License: mit
- Created: 2020-10-04T20:05:34.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-26T17:25:13.000Z (over 3 years ago)
- Last Synced: 2025-04-09T23:11:26.471Z (9 months ago)
- Topics: docsify, docsify-js, docsify-plugin, ethicalads
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docsify-ethicalads
EthicalAds support for Docsify
## Usage
```html
```
```js
window.$docsify = {
name: 'Test',
loadSidebar: true,
plugins: [
DocsifyEthicalAds.create('ethicalads-publisher-id', {
type: 'image'
})
]
}
```
## Options
``type`` - Either "image" or "text" (default: image)
``horizontal`` - Boolean, allows the ad to be horizontal instead of vertical (default: false)
``dark`` - Boolean, whether or not dark theme is on the advert or not (default: false)
``theme`` - One of the themes [here](https://ethical-ad-client.readthedocs.io/en/latest/#themes) (default: see EthicalAds documentation)
``keywords`` - "data-ea-keywords" (default: see EthicalAds documentation)
``campaignTypes`` - "data-ea-campaign-types" (default: see EthicalAds documentation)
``placementID`` - Placement ID for the ad element (default: none)
``forceAd`` - Ad to force show for testing (default: none)
``forceCampaign`` - Campaign to force show for testing (default: none)
``manual`` - Require manual loading of ads at a certain time (default: false)
## Credits
[docsify-plugin-carbon](https://github.com/waruqi/docsify-plugin-carbon) - Reference
[EthicalAds Documentation](https://ethical-ad-client.readthedocs.io/en/latest/#configuration) - Reference