streetsidesoftware · Jason3S · Sep 11, 2023 · Sep 11, 2023 · Sep 11, 2023
diff --git a/docs/.cspell.json b/docs/.cspell.json
@@ -8,5 +8,5 @@
         }
     ],
     "enableFiletypes": ["ruby"],
-    "ignorePaths": ["_site/**"]
+    "ignorePaths": ["_site/**", "_includes/generated-docs"]
 }
diff --git a/docs/_includes/generated-docs/README.md b/docs/_includes/generated-docs/README.md
@@ -0,0 +1,107 @@
+<!--- @@inject: ../../../README.md --->
+
+# CSpell
+
+[![unit tests](https://github.com/streetsidesoftware/cspell/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions)
+[![integration tests](https://github.com/streetsidesoftware/cspell/actions/workflows/integration-test.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions)
+[![lint](https://github.com/streetsidesoftware/cspell/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions)
+[![coverage](https://github.com/streetsidesoftware/cspell/actions/workflows/coverage.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions)
+
+[![codecov](https://codecov.io/gh/streetsidesoftware/cspell/branch/main/graph/badge.svg?token=Dr4fi2Sy08)](https://codecov.io/gh/streetsidesoftware/cspell)
+[![Coverage Status](https://coveralls.io/repos/github/streetsidesoftware/cspell/badge.svg?branch=main)](https://coveralls.io/github/streetsidesoftware/cspell)
+
+The CSpell mono-repo, a spell checker for code.
+
+## Support Future Development
+
+- [![GitHub Sponsors](https://img.shields.io/badge/-black?style=social&logo=githubsponsors&label=GitHub%20Sponsor%3A%20Street%20Side%20Software)](https://github.com/sponsors/streetsidesoftware)
+- [![Patreon](https://img.shields.io/badge/-black?style=social&logo=patreon&label=Patreon%3A%20Street%20Side%20Software)](https://patreon.com/streetsidesoftware)
+- [![PayPal](https://img.shields.io/badge/-black?style=social&logo=paypal&label=PayPal%20Donate%3A%20Street%20Side%20Software)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY)
+- [![Open Collective](https://img.shields.io/badge/-black?style=social&logo=opencollective&label=Open%20Collective%3A%20CSpell)](https://opencollective.com/cspell)
+
+## Documentation
+
+[Documentation - CSpell](https://streetsidesoftware.github.io/cspell/)
+
+## Third-Party Video Presentations
+
+Some videos related to CSpell and the [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for VS Code.
+
+- [Spell Checking Documentation in DevOps Pipelines](https://www.youtube.com/watch?v=w8gGi3aeVpc) by Houssem Dellai
+- [Don't Worry About Spelling...VS Code Can Do It For You!!](https://www.youtube.com/watch?v=MfxFMFMsBP4) by [James Q Quick](https://www.youtube.com/@JamesQQuick)
+- [Spell Checking In VSCode - VSCode Pro Tips](https://www.youtube.com/watch?v=_GwpPJgH1Gw)
+- [Spell Check in VS Code with Code Spell Checker | Extension Highlight](https://www.youtube.com/watch?v=ZxNnOjWetH4)
+- [Spell check your code from the command line with Cspell](https://www.youtube.com/watch?v=nwmJ9h_zPJc)
+- [How to Use VS Code Spell Checker](https://www.youtube.com/watch?v=Ix5bMd0kZeY) - Detailed walkthrough to setup and use multiple languages
+- [Code Spell Checker Extension for Visual Studio Code](https://www.youtube.com/watch?v=dUn1mrJYMrM)
+
+## Packages
+
+- [cspell](packages/cspell) [![Verified on Openbase](https://badges.openbase.com/js/verified/cspell.svg?token=N5IXZIAqMY+0I+KuQhPpfoZYw0QUz/LiSYlOerD8Pio=)](https://openbase.com/js/cspell?utm_source=embedded&utm_medium=badge&utm_campaign=verified-badge&utm_term=js/cspell) -- cspell command-line application
+- [@cspell/eslint-plugin](packages/cspell-eslint-plugin) [![Verified on Openbase](https://badges.openbase.com/js/verified/@cspell/eslint-plugin.svg?token=SVzjSaHtOWCFmjBOgw1W6CuYHDw29Vx77pNj7v5lPRE=)](https://openbase.com/js/@cspell/eslint-plugin?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge) -- CSpell ESLint Plugin
+- [cspell-bundled-dicts](packages/cspell-bundled-dicts) -- collection of dictionaries bundled with cspell.
+- [cspell-glob](packages/cspell-glob) -- glob library.
+- [cspell-io](packages/cspell-io) -- i/o library.
+- [cspell-lib](packages/cspell-lib) -- cspell library used for code driven spelling checking (used by the application).
+- [cspell-types](packages/cspell-types) -- cspell types and JSON schema for cspell configuration files.
+- [cspell-tools](packages/cspell-tools) -- tool used to compile dictionaries.
+- [cspell-trie-lib](packages/cspell-trie-lib) -- trie data structure used to store words.
+- [cspell-trie](packages/cspell-trie) -- trie data tool used to store words.
+- [hunspell-reader](packages/hunspell-reader) -- reads Hunspell files and outputs words.
+
+## Related Packages
+
+- [cspell-cli](https://github.com/streetsidesoftware/cspell-cli) -- `cspell-cli` is useful for including `cspell` directly from GitHub.
+
+  Example install: `npm install -g git+https://github.com/streetsidesoftware/cspell-cli`.
+
+  This will add the `cspell-cli` command, which is an alias of the `cspell` command.
+
+## RFCs
+
+| Link                                                           | Description                     | Status      |
+| -------------------------------------------------------------- | ------------------------------- | ----------- |
+| [rfc-0001](rfc/rfc-0001%20suggestions/)                        | Fixing common misspellings      | Not started |
+| [rfc-0002](rfc/rfc-0002%20improve%20dictionary%20suggestions/) | Improving Generated Suggestions | Done        |
+| [rfc-0003](rfc/rfc-0003%20parsing%20files/)                    | Plug-ins: Adding file parsers   | In Progress |
+| [rfc-0004](rfc/rfc-0004%20known%20issues/)                     | Support Marking Issues as Known | Not started |
+
+## CSpell for enterprise
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of CSpell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
+
+## Security contact information
+
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
+## Versions
+
+|        | version | Node    | Status                       | Maintenance | End of Free Support |
+| :----- | :------ | :------ | :--------------------------- | :---------- | :------------------ |
+| cspell | 8.x     | 18.x    | In Active Development        | TBD         | TBD                 |
+| cspell | 7.x     | 16.x    | Transitioning to Maintenance | 2023-10-01  | 2023-11-01          |
+| cspell | 6.x     | 14.14.x | Paid support only[^1]        | 2023-04-01  | 2023-05-01          |
+| cspell | 5.x     | 12.x    | Paid support only[^1]        | -           | 2022-10-01          |
+| cspell | 4.x     | 10.x    | Paid support only[^1]        | -           | 2022-05-01          |
+
+[^1]: [Support - Street Side Software](https://streetsidesoftware.com/support/#maintenance-agreements)
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!---
+cspell:ignore Houssem Dellai
+--->
+
+<!--- @@inject-end: ../../../README.md --->
diff --git a/docs/docs/help-lint.md → docs/_includes/generated-docs/help-lint.md b/docs/docs/help-lint.md → docs/_includes/generated-docs/help-lint.md
@@ -1,4 +1,4 @@
-<!--- @@inject: ../../packages/cspell/static/help-lint.txt --->
+<!--- @@inject: ../../../packages/cspell/static/help-lint.txt --->
 
 ```
 Usage: cspell lint [options] [globs...] [file://<path> ...] [stdin[://<path>]]
@@ -97,4 +97,4 @@ References:
     https://github.com/streetsidesoftware/cspell
 ```
 
-<!--- @@inject-end: ../../packages/cspell/static/help-lint.txt --->
+<!--- @@inject-end: ../../../packages/cspell/static/help-lint.txt --->
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md
@@ -155,4 +155,4 @@ cspell lint --help
 
 ### Options
 
-{% include_relative help-lint.md %}
+{% include  generated-docs/help-lint.md %}
diff --git a/docs/index.md b/docs/index.md
@@ -7,75 +7,4 @@ description: 'CSpell - A spell checker for code!'
 permalink: /
 ---
 
-# Welcome to CSpell
-
-A Spell Checker for Code!
-
-`cspell` is a command line tool and library for spell checking code.
-
-## Support Future Development
-
-- Become a [<img src="https://github.githubassets.com/images/modules/site/icons/funding_platforms/patreon.svg" width="16" height="16" alt="Patreon">Patreon!](https://patreon.com/streetsidesoftware)
-- [Support through ![PayPal](./assets/images/paypal-logo-wide-16.png)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY)
-
-## Features
-
-- Spell Checks Code -- Able to spell check code by parsing it into words before checking against the dictionaries.
-- Supports CamelCase, snake_case, and compoundwords naming styles.
-- Self contained -- does not depend upon OS libraries like Hunspell or aspell. Nor does it depend upon online services.
-- Fast -- checks 1000's of lines of code in seconds.
-- Programming Language Specific Dictionaries -- Has dedicated support for:
-  - JavaScript, TypeScript, Python, PHP, C#, C++, LaTex, Go, HTML, CSS, etc.
-- Customizable -- supports custom dictionaries and word lists.
-- Continuous Integration Support -- Can easily be added as a linter to Travis-CI.
-
-CSpell was initially built as the spell checking service for the [spell checker extension](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for
-[Visual Studio Code](https://code.visualstudio.com/).
-
-## CSpell for Enterprise
-
-Available as part of the Tidelift Subscription.
-
-The maintainers of CSpell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
-
-## Installation
-
-```sh
-npm install -g cspell
-```
-
-## Basic Usage
-
-Example: recursively spell check all JavaScript files in `src`
-
-**JavaScript files**
-
-```sh
-cspell "src/**/*.js"
-# or
-cspell lint "src/**/*.js"
-```
-
-**Check everything**
-
-```sh
-cspell "**"
-```
-
-## Getting Started
-
-See: [Getting Started](./docs/getting-started.md)
-
-## Requirements
-
-|        | version | Node | Support                     | End-Of-Life |
-| :----- | :------ | :--- | :-------------------------- | :---------- |
-| cspell | 6.x     | 14.x | In Active Development       | TBD         |
-| cspell | 5.x     | 12.x | Security and bug fixes      | 2023-05-01  |
-| cspell | 4.x     | 10.x | Paid support only[^support] | 2022-05-01  |
-
-<!---
-cspell:ignore compoundwords paypal
---->
-
-[^support]: [Support - Street Side Software](https://streetsidesoftware.com/support/#maintenance-agreements)
+{% include generated-docs/README.md %}