Merge pull request #716 from imnasnainaec/patch-1

Update docs to match code and fix a few typos

Author: orestbida

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:
 

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]]
 

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
 <script
     type="text/plain"
     data-category="!analytics">
-    // Executed when the "analytics category is disabled
+    // Executed when the "analytics" category is disabled
 </script>
 ```
 

docs/components/icons.js

@@ -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:
 <br>
 
-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/[email protected]/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.
 
 <br>
 

docs/essential/getting-started.md

@@ -30,7 +30,7 @@ Both versions are very similar but there a few key differences:
 <CheckListItem title="Supports modern browsers only" type="i"/>
 
 ## 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.
 
 <script setup>
 import CheckListItem from "../components/CheckListItem.vue"

docs/essential/introduction.md

@@ -21,7 +21,7 @@ hero:
 
 features:
   - title: Lightweight
-    details: Small footprint with a minimal impact on your website's performance
+    details: Small footprint with a minimal impact on your website's performance.
   - title: Versatile
     details: A wide range of options and API to handle many different types of configurations.
   - title: Accessible

docs/index.md

@@ -764,7 +764,7 @@ Define the translation(s) content.
     ```
 - **Details**:
 
-    You can define an `inline` translation object, or specify the path to an `external .json` translation file.
+    You can define an `inline` translation object, or specify the path to an external `.json` translation file.
 
 - **Examples**:
 
@@ -833,7 +833,7 @@ Define the translation(s) content.
 - **Details**:
     - `closeIconLabel`: if specified, a big `X` button will be generated (visible only in the `box` layout). It acts the same as `acceptNecessaryBtn`.
     - `revisionMessage`: check out the dedicated [revision section](/advanced/revision-management.html#revision-message).
-    - `footer`: a small area where you can place your links (impressum, privacy policy ...)
+    - `footer`: a small area where you can place your links (impressum, privacy policy, ...)
 
     <br>
 

docs/reference/configuration-reference.md

@@ -1,7 +1,7 @@
 ---
 import '../../styles/header.scss';
 import { docsUrl, stackblitzUrl, repoUrl } from "../../data/metadata";
-import { GithubIcon } from '../../data/icons';
+import { GitHubIcon } from '../../data/icons';
 ---
 <header>
     <h1 class="page-title">CookieConsent v3<span data-latest-release data-minor-release class="fade-in title__minor-version">.0.0</span></h1>
@@ -10,6 +10,6 @@ import { GithubIcon } from '../../data/icons';
     <div class="main-links">
         <a href={docsUrl} class="styled-link" target="_blank" rel="noopener noreferrer">📃 Documentation</a>
         <a href={stackblitzUrl} class="styled-link styled-link__2" target="_blank" rel="noopener noreferrer">Live demos</a>
-        <a href={repoUrl} class="styled-link styled-link__2 github-icon" target="_blank" set:html={GithubIcon} aria-label="Github repository"></a>
+        <a href={repoUrl} class="styled-link styled-link__2 github-icon" target="_blank" set:html={GitHubIcon} aria-label="GitHub repository"></a>
     </div>
 </header>

playground/src/components/sections/Header.astro

@@ -17,7 +17,7 @@ import { docsUrl, repoUrl } from '../../data/metadata'
             </br>
             If you can't find what you're looking for, feel free to
             open an <a href={`${repoUrl}/issues`} target="_blank" rel="noopener noreferrer">issue</a>
-            or a <a href={`${repoUrl}/discussions`} target="_blank" rel="noopener noreferrer">discussion</a> on github.
+            or a <a href={`${repoUrl}/discussions`} target="_blank" rel="noopener noreferrer">discussion</a> on GitHub.
         </p>
     </div>
 </section>