Skip to content

Commit

Permalink
docs: add description to index and further improve existing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
axe312ger committed Dec 31, 2023
1 parent b330c58 commit c6a11a2
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
4 changes: 4 additions & 0 deletions packages/docs/docs/components/core/privacy-shield.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
| `children` | `React.ReactNode` | The content to render if consent is given. |
| `...props` | `unknown` | Additional props passed to the fallback component. |

## Prefer a Custom Placeholder or Fallback Component?

Set it up globally using the `fallbackComponent` property in the [`ConsentManager` component](./consent-manager.md).

## Example Usage
```jsx
import { PrivacyShield } from '@consent-manager/core';
Expand Down
4 changes: 3 additions & 1 deletion packages/docs/docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Your application now includes Consent Manager, displaying the shield 🛡️ ico

## Integrating Matomo for Tracking Page Views and Events

Matomo is a robust, open-source alternative to SAAS tracking solutions, offering full data control and GDPR-friendly implementation.
[Matomo is a robust, open-source alternative to SAAS tracking solutions](https://matomo.org/google-analytics-alternative/), offering full data control and GDPR-friendly implementation.

### Installing Matomo Integration
First, add the [Matomo integration](./integrations/matomo.md) to your project:
Expand Down Expand Up @@ -171,4 +171,6 @@ export default YouTube;

[Explore more about YouTube integration](./integrations/youtube.md).

## Fin

You now have the fundamental knowledge to integrate Consent Manager into your React application. For more detailed guides, please refer to the sidebar on the left.
2 changes: 2 additions & 0 deletions packages/docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ const path = require('path')
module.exports = {
title: 'Consent Manager',
tagline: 'Simplify GDPR Compliance: Seamless and User-Centric',
description:
'Explore Consent Manager: GDPR-compliant, i18n-supported, plugin-rich and developer-friendly toolkit for fair user consent management in web apps with custom interfaces.',
url: 'https://hashbite.github.io/',
baseUrl: '/consent-manager/',
onBrokenLinks: 'throw',
Expand Down

0 comments on commit c6a11a2

Please sign in to comment.