Merge pull request #1615 from codatio/chore/lint-markdown

Lint md with prettier

Author: mcclowes

.github/workflows/check-formatting.yml

@@ -22,4 +22,4 @@ jobs:
         run: npm ci
 
       - name: Check formatting
-        run: npm run format:check 
+        run: npm run format:js:check 

.github/workflows/check-markdown-lint.yml

@@ -1,4 +1,4 @@
-name: Check - linting
+name: Check - markdown formatting
 
 on:
   pull_request:
@@ -17,7 +17,7 @@ on:
       - 'docs/**/*.mdx'
 
 jobs:
-  markdown-lint:
+  markdown-format:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -29,8 +29,8 @@ jobs:
           node-version: '20'
           cache: 'npm'
 
-      - name: Install markdownlint
-        run: npm install -g markdownlint-cli
+      - name: Install dependencies
+        run: npm ci
 
-      - name: Run markdownlint
-        run: markdownlint 'blog/**/*.md' 'blog/**/*.mdx' 'docs/**/*.md' 'docs/**/*.mdx' --config .markdownlint.json 
+      - name: Check markdown formatting with Prettier
+        run: npm run format:mdx:check 

.markdownlint.json

@@ -6,5 +6,13 @@ module.exports = {
         parser: "mdx",
       },
     },
+    {
+      files: "*.mdx",
+      options: {
+        parser: "mdx",
+        proseWrap: "always",
+        printWidth: 80,
+      },
+    },
   ],
 };

.prettierrc.js

@@ -32,7 +32,7 @@ All `.jpg`, `.jpeg`, and `.png` files are tracked.
 The docusaurus config expects certain environment variables to be defined. We've included `.env.example` - copy this and rename it to `.env`. You can enter any random string for the IDs.
 
 ```
-copy .env.example .env # on Windows 
+copy .env.example .env # on Windows
 cp .env.example .env # on Mac
 ```
 

README.md

@@ -6,10 +6,10 @@ draft: false
 authors: mcclowes
 ---
 
-6/8/2022 Portal, Updates We've updated the navigation bar in the Codat Portal to make your experience more intuitive. 
+6/8/2022 Portal, Updates We've updated the navigation bar in the Codat Portal to make your experience more intuitive.
 
 7/1/2022 Assess, New Banking metrics are now available for all clients using Assess.
 
 <!--truncate-->
 
-[Access our help center](https://codat.zendesk.com/hc/en-gb).
+[Access our help center](https://codat.zendesk.com/hc/en-gb).

blog/220714-support.md

@@ -10,6 +10,6 @@ The Portal has been rearranged to make accessing Codat functionality and setting
 
 <!--truncate-->
 
-- The vertical navbar has been replaced with a horizontal one, and sections of the Portal have their own vertical nav in its place. 
+- The vertical navbar has been replaced with a horizontal one, and sections of the Portal have their own vertical nav in its place.
 - All settings are now in the settings section.
-- We've added a monitor section for the functionality that helps you monitor and maintain a healthy Codat solution.
+- We've added a monitor section for the functionality that helps you monitor and maintain a healthy Codat solution.

blog/220806-navigation-bar.md

@@ -6,11 +6,10 @@ draft: false
 authors: mcclowes
 ---
 
-> Instant Match is available for nearly 3,000 U.S. additional financial institutions where Instant Auth is not available. 
+> Instant Match is available for nearly 3,000 U.S. additional financial institutions where Instant Auth is not available.
 
 <!--truncate-->
 
 > Instant Match is enabled automatically for Auth customers and is automatically provided at supported institutions as a fallback experience when Instant Auth is not available. When using Instant Match, Plaid Link will prompt your user to enter their account number and routing number for a depository account. Plaid will then verify the last four digits of the user-provided account number against the account mask retrieved from the financial institution.
 
-
-[Read more...](https://plaid.com/docs/auth/coverage/instant/#instant-match)
+[Read more...](https://plaid.com/docs/auth/coverage/instant/#instant-match)

blog/220817-plaid-instant-match.md

@@ -20,4 +20,4 @@ We've got a host of Portal and DX improvements for you this week.
 
 #### Assess
 
-- **New:** Banking metrics are now available for all clients using Assess. 
+- **New:** Banking metrics are now available for all clients using Assess.

blog/220817-product-update.md

@@ -15,7 +15,6 @@ To use the updated request body before this date, enable the relevant feature bu
 Action required
 Update the body of any requests to the `POST /companies/{companyId}/connections` endpoint from a string value to the JSON object as specified below:
 
-
 ```JSON
 {
   "platformKey": "string",
@@ -53,7 +52,6 @@ A POST request body that is not a JSON object containing a platformKey property
 
 Legacy request body for `POST /companies/{companyId}/connections endpoint` available only for clients onboarded prior to September 1, 2022. This model is being replaced on January 10, 2023.
 
-
 New request body for `POST /companies/{companyId}/connections endpoint` available for clients onboarded from September 1, 2022. This model will be implemented for all other clients on January 10, 2023.
 
 ```JSON
@@ -63,4 +61,4 @@ New request body for `POST /companies/{companyId}/connections endpoint` availabl
 }
 ```
 
-You can get ahead of this change by enabling it now in the Portal.
+You can get ahead of this change by enabling it now in the Portal.