docs: Add footer (#2503)

README.md

@@ -9,6 +9,7 @@ The goal of this spell checker is to help catch common spelling errors while kee
 -   Become a [![Patreon](https://raw.githubusercontent.com/streetsidesoftware/vscode-spell-checker/main/images/patreon/Digital-Patreon-Logo_FieryCoral_16x16.png) Patreon!](https://patreon.com/streetsidesoftware)
 
 -   [Support through ![PayPal](https://raw.githubusercontent.com/streetsidesoftware/vscode-spell-checker/main/images/PayPal/paypal-logo-wide-18.png)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY)
+
 -   [Open Collective](https://opencollective.com/code-spell-checker)
 
 ## Sponsors
@@ -110,11 +111,11 @@ Open up VS Code and hit `F1` and type `ext` select install and type `code-spell-
 
 To _Enable_ or _Disable_ spell checking for a file type:
 
-1. Click on the Spell Checker status in the status bar:
+1.  Click on the Spell Checker status in the status bar:
 
  <img width="57" alt="Spell Checker Status Bar" src="https://user-images.githubusercontent.com/3740137/177296936-54d5a88c-a596-4178-bd91-0be06161e1fc.png">
 
-2. On the Info screen, click the checkbox.
+2.  On the Info screen, click the checkbox.
 
  <img width="710" alt="Spell Checker Information Window" src="https://user-images.githubusercontent.com/3740137/177297717-88da81d8-9a8c-4907-9424-66e013899318.png">
 
@@ -172,6 +173,7 @@ It is possible to disable / enable the spell checker by adding comments to your
 -   `/* spellchecker: disable */`
 -   `/* cspell: disable-line */`
 -   `/* cspell: disable-next-line */`
+
 <!--- cSpell:enable -->
 
 #### Enable Checking
@@ -257,9 +259,9 @@ By default the flags `gim` are added if no flags are given.
 
 The spell checker works in the following way:
 
-1. Find all text matching `includeRegExp`
-2. Remove any text matching `excludeRegExp`
-3. Check the remaining text.
+1.  Find all text matching `includeRegExp`
+1.  Remove any text matching `excludeRegExp`
+1.  Check the remaining text.
 
 #### Exclude Example
 
@@ -305,8 +307,8 @@ def sum_it(self, seq):
 ### Exclude patterns
 
 -   `Urls`<sup>1</sup> -- Matches urls
--   `HexValues` -- Matches common hex format like #aaa, 0xfeef, \\u0134
--   `EscapeCharacters`<sup>1</sup> -- matches special characters: '\\n', '\\t' etc.
+-   `HexValues` -- Matches common hex format like `#aaa`, `0xfeef`, `\u0134`
+-   `EscapeCharacters`<sup>1</sup> -- matches special characters: `\n`, `\t` etc.
 -   `Base64`<sup>1</sup> -- matches base64 blocks of text longer than 40 characters.
 -   `Email` -- matches most email addresses.
 
@@ -325,9 +327,9 @@ The spell checker configuration can be controlled via VS Code preferences or `cs
 
 Order of precedence:
 
-1. Workspace Folder `cspell.json`
-1. Workspace Folder `.vscode/cspell.json`
-1. VS Code Preferences `cSpell` section.
+1.  Workspace Folder `cspell.json`
+1.  Workspace Folder `.vscode/cspell.json`
+1.  VS Code Preferences `cSpell` section.
 
 ### Adding words to the Workspace Dictionary
 
@@ -722,3 +724,17 @@ See: [FAQ](https://github.com/streetsidesoftware/vscode-spell-checker/blob/main/
     cSpell:words Verdana
     cSpell:locale en
 -->
+
+<!--- @@inject: ./static/footer.md --->
+
+<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>
+
+<!--- @@inject-end: ./static/footer.md --->

docs/_scripts/extract-config.js

@@ -19,7 +19,7 @@ ${sectionTOC(configSections)}
 
 ${formatSections(configSections)}
 
-`.replace(/\*\u200B/g, '*'); // remove zero width spaces
+`.replace(/\u200B/g, ''); // remove zero width spaces
 
 console.log(doc);
 

package.json

@@ -2459,22 +2459,25 @@
     ]
   },
   "scripts": {
-    "build-tools": "build-tools",
-    "build-package-schema": "yarn workspace server build-schema && build-tools update-package-schema && yarn prettier-fix-schema",
+    "build-package-schema": "yarn workspace server build-schema && build-tools update-package-schema && yarn prettier:fix-schema",
     "postinstall": "yarn run build",
-    "build": "yarn workspaces run build && yarn run build-package-schema && yarn run gen-docs",
+    "build": "yarn build:workspaces && yarn build:schema && yarn build:docs && yarn build:readme",
+    "build:docs": "yarn run gen-docs",
+    "build:readme": "inject-markdown README.md && prettier -w README.md",
+    "build:schema": "yarn run build-package-schema",
+    "build:workspaces": "yarn workspaces run build",
     "clean": "yarn workspaces run clean && shx rm -rf \"packages/*/node_modules\"",
     "build-production": "yarn workspaces run build-production",
     "build-release": "yarn run build && yarn run package-extension",
     "gen-docs": "yarn workspace @internal/docs gen-docs",
     "package-extension": "vsce package -o ./build",
-    "prettier": "prettier \"**/*.{ts,tsx,js,json,md}\" -c",
-    "prettier-fix": "yarn run prettier -w",
-    "prettier-fix-schema": "prettier -w \"**/*.schema.json\"",
+    "prettier:check": "prettier \"**/*.{ts,tsx,js,json,md}\" -c",
+    "prettier:fix": "yarn prettier:check -w",
+    "prettier:fix-schema": "prettier -w \"**/*.schema.json\"",
     "test-vsce-build": "vsce package -o ./temp",
     "remove-test-files": "shx rm -rf \"packages/*/{out,dist,settingsViewer}/**/*.test.js\"",
     "vscode:prepublish": "yarn run build-production && yarn run remove-test-files",
-    "lint": "yarn workspaces run lint && yarn run prettier",
+    "lint": "yarn workspaces run lint && yarn prettier:check",
     "lint-docs": "prettier -w \"docs/**/*.{md,markdown,yaml,yml,json,html,htm,js,ts}\"",
     "lint-docs-ci": "prettier -c \"docs/**/*.{md,markdown,yaml,yml,json,html,htm,js,ts}\"",
     "test-client-integration": "yarn workspace integration-tests test-integration",
@@ -2487,6 +2490,7 @@
     "@typescript-eslint/parser": "^4.33.0",
     "@vscode/vsce": "^2.17.0",
     "eslint": "^7.32.0",
+    "inject-markdown": "^1.5.0",
     "ovsx": "^0.8.0",
     "prettier": "^2.8.3",
     "shx": "^0.3.4",

static/footer.md

@@ -0,0 +1,9 @@
+<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>