diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d4506f3..afa0fab2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ If you encountered a problem, [search if an issue already exists](https://github npm i -g pnpm ``` - 3. Follow the [Getting started with Github Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop) guide. + 3. Follow the [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop) guide. 1. #### Make changes locally @@ -43,7 +43,7 @@ If you encountered a problem, [search if an issue already exists](https://github pnpm dev ``` - Note: If you're making changes to the documentation, use `pnpm dev:docs`. + Note: If you're making changes to the documentation, use `pnpm docs:dev`. 5. Once you've finished, generate the bundled version via: diff --git a/docs/additional/faq.md b/docs/additional/faq.md index 89bfb82f..ff0f803f 100644 --- a/docs/additional/faq.md +++ b/docs/additional/faq.md @@ -1,5 +1,5 @@ # Frequently Asked Questions -Couldn't find the answer in the documentation? Feel free to open a [discussion](https://github.com/orestbida/cookieconsent/discussions) on github. +Couldn't find the answer in the documentation? Feel free to open a [discussion](https://github.com/orestbida/cookieconsent/discussions) on GitHub. [[toc]] diff --git a/docs/advanced/manage-scripts.md b/docs/advanced/manage-scripts.md index 5fd2f24f..5ba4d268 100644 --- a/docs/advanced/manage-scripts.md +++ b/docs/advanced/manage-scripts.md @@ -22,7 +22,7 @@ Example usage: ## How to block/manage a script tag -You can manage any script tag. by adding the following 2 attributes (both required): +You can manage any script tag by adding the following 2 attributes (both required): - `type="text/plain"` - `data-category="your-category-name"` @@ -49,7 +49,7 @@ You can also run **scripts when a category is disabled** (if it was previously e ``` diff --git a/docs/components/icons.js b/docs/components/icons.js index cdf9354a..fa7a2d08 100644 --- a/docs/components/icons.js +++ b/docs/components/icons.js @@ -1,5 +1,5 @@ // Navbar icons -export const GithubIcon = ``; +export const GitHubIcon = ``; export const HeartIcon = ``; // Block icons diff --git a/docs/essential/getting-started.md b/docs/essential/getting-started.md index abf1c5db..dfe72fda 100644 --- a/docs/essential/getting-started.md +++ b/docs/essential/getting-started.md @@ -7,7 +7,7 @@ This section will help you install CookieConsent in your app/website. You can download/import the plugin using one of the following methods:
-1. Install via [NPM](https://www.npmjs.com/package/vanilla-cookieconsent). +1. Install via [NPM](https://www.npmjs.com/package/vanilla-cookieconsent) or [Yarn](https://yarnpkg.com/package?name=vanilla-cookieconsent). ::: code-group @@ -39,7 +39,7 @@ You can download/import the plugin using one of the following methods: https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@3.0.1/dist/cookieconsent.umd.js ``` -3. Download the [latest release](https://github.com/orestbida/cookieconsent/releases?q=cookieconsent+v3) from github and use the optimized files located in the `dist` folder. +3. Download the [latest release](https://github.com/orestbida/cookieconsent/releases?q=cookieconsent+v3) from GitHub and use the optimized files located in the `dist` folder. ## Usage @@ -266,7 +266,7 @@ CookieConsent.run({ // domain: location.hostname, // path: '/', // sameSite: "Lax", - // expiresAfterDays: 365, + // expiresAfterDays: 182, }, // https://cookieconsent.orestbida.com/reference/configuration-reference.html#guioptions @@ -426,7 +426,7 @@ You should now see the consent modal pop up! You can also define [external translation files](/advanced/language-configuration.html#external-translations). ::: -If you're having trouble setting up the plugin, you can check out a few [demo examples](https://github.com/orestbida/cookieconsent/tree/master/demo) on github. +If you're having trouble setting up the plugin, you can check out a few [demo examples](https://github.com/orestbida/cookieconsent/tree/master/demo) on GitHub.
diff --git a/docs/essential/introduction.md b/docs/essential/introduction.md index c032d383..095211e3 100644 --- a/docs/essential/introduction.md +++ b/docs/essential/introduction.md @@ -30,7 +30,7 @@ Both versions are very similar but there a few key differences: ## More questions? -Check the [FAQ](/additional/faq.html) section or open a [new discussion](https://github.com/orestbida/cookieconsent/discussions/new) on github. +Check the [FAQ](/additional/faq.html) section or open a [new discussion](https://github.com/orestbida/cookieconsent/discussions/new) on GitHub.