chore(maintenance): add markdownlint

.github/workflows/reusable-run-linting-check-and-unit-tests.yml

@@ -90,3 +90,19 @@ jobs:
         uses: ./.github/actions/cached-node-modules
       - name: Run linting
         run: npm run lint -w docs/snippets
+  check-docs:
+    runs-on: ubuntu-latest
+    env:
+      NODE_ENV: dev
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f  # v4.1.3
+      - name: Setup NodeJS
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        with:
+          node-version: 20
+          cache: "npm"
+      - name: Setup dependencies
+        uses: ./.github/actions/cached-node-modules
+      - name: Run linting
+        run: npm run lint:markdown

.markdownlint.yaml

@@ -0,0 +1,226 @@
+# Rules: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
+MD001: true
+
+# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
+# NOTE: We use h2 due to font size
+MD002: false
+
+# MD003/heading-style/header-style - Heading style
+MD003:
+  # Heading style
+  style: "consistent"
+
+# MD004/ul-style - Unordered list style
+MD004:
+  # List style
+  style: "consistent"
+
+# MD005/list-indent - Inconsistent indentation for list items at the same level
+MD005: true
+
+# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line
+MD006: true
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 4
+  # Whether to indent the first level of the list
+  start_indented: false
+  # Spaces for first level indent (when start_indented is set)
+  start_indent: 2
+
+# MD009/no-trailing-spaces - Trailing spaces
+MD009:
+  # Spaces for line break
+  br_spaces: 2
+  # Allow spaces for empty lines in list items
+  list_item_empty_lines: false
+  # Include unnecessary breaks
+  strict: false
+
+# MD010/no-hard-tabs - Hard tabs
+# NOTE: Mkdocs Material theme features like code annotations, tabbed content require it
+MD010: false
+
+# MD011/no-reversed-links - Reversed link syntax
+MD011: true
+
+# MD012/no-multiple-blanks - Multiple consecutive blank lines
+MD012:
+  # Consecutive blank lines
+  maximum: 1
+
+# MD013/line-length - Line length
+MD013:
+  # Number of characters
+  line_length: 380
+  # Number of characters for headings
+  heading_line_length: 80
+  # Number of characters for code blocks
+  code_block_line_length: 265
+  # Include code blocks
+  code_blocks: true
+  # Include tables
+  tables: false
+  # Include headings
+  headings: true
+  # Strict length checking
+  strict: false
+  # Stern length checking
+  stern: false
+
+# MD014/commands-show-output - Dollar signs used before commands without showing output
+MD014: true
+
+# MD018/no-missing-space-atx - No space after hash on atx style heading
+MD018: true
+
+# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
+MD019: true
+
+# MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading
+MD020: true
+
+# MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading
+MD021: true
+
+# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
+MD022:
+  # Blank lines above heading
+  lines_above: 1
+  # Blank lines below heading
+  lines_below: 1
+
+# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
+MD023: true
+
+# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+MD024:
+  # Only check sibling headings
+  siblings_only: false
+
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+MD025:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
+
+# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
+MD027: true
+
+# MD028/no-blanks-blockquote - Blank line inside blockquote
+MD028: true
+
+# MD029/ol-prefix - Ordered list item prefix
+MD029:
+  # List style
+  style: "one_or_ordered"
+
+# MD030/list-marker-space - Spaces after list markers
+MD030:
+  # Spaces for single-line unordered list items
+  ul_single: 1
+  # Spaces for single-line ordered list items
+  ol_single: 1
+  # Spaces for multi-line unordered list items
+  ul_multi: 1
+  # Spaces for multi-line ordered list items
+  ol_multi: 1
+
+# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
+MD031:
+  # Include list items
+  list_items: true
+
+# MD032/blanks-around-lists - Lists should be surrounded by blank lines
+MD032: true
+
+# MD033/no-inline-html - Inline HTML
+# NOTE: Some content like Logger '<module>' triggers false positives
+MD033: false
+
+# MD034/no-bare-urls - Bare URL used
+MD034: true
+
+# MD035/hr-style - Horizontal rule style
+MD035:
+  # Horizontal rule style
+  style: "consistent"
+
+# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
+# NOTE: We use **<topic>** instead of yet another sub-heading that might not appear in the navigation.
+# this is a trade-off we make to not a gigantic right-navigation
+MD036: false
+
+# MD037/no-space-in-emphasis - Spaces inside emphasis markers
+MD037: true
+
+# MD038/no-space-in-code - Spaces inside code span elements
+# mkdocs-material requires these in tab content
+MD038: false
+
+# MD039/no-space-in-links - Spaces inside link text
+MD039: true
+
+# MD040/fenced-code-language - Fenced code blocks should have a language specified
+MD040: true
+
+# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD042/no-empty-links - No empty links
+# NOTE: Clipboard links like Lambda Layers use empty links
+MD042: false
+
+# MD043/required-headings/required-headers - Required heading structure
+MD043: false
+
+# MD044/proper-names - Proper names should have the correct capitalization
+MD044:
+  # List of proper names
+  names: []
+  # Include code blocks
+  code_blocks: true
+  # Include HTML elements
+  html_elements: true
+
+# MD045/no-alt-text - Images should have alternate text (alt text)
+MD045: true
+
+# MD046/code-block-style - Code block style
+# Material theme tabbed content feature use indented and simple use fenced; can't support both
+MD046: false
+
+# MD047/single-trailing-newline - Files should end with a single newline character
+MD047: true
+
+# MD048/code-fence-style - Code fence style
+MD048: false
+
+# MD051/link-fragments - Link fragments should be valid
+MD051: true
+
+# MD052/reference-links-images - Reference links and images should use a label that is defined
+MD052: true
+
+# MD053/link-image-reference-definitions - Link and image reference definitions should be needed
+MD053: true

.markdownlintignore

@@ -0,0 +1,22 @@
+# built artifacts
+site/**
+api/**
+# changelogs - these are not linted as they are auto-generated
+CHANGELOG.md
+packages/*/CHANGELOG.md
+examples/*/CHANGELOG.md
+layers/*/CHANGELOG.md
+# other files
+LICENSE
+.github/**
+**node_modules/** */
+# these will be removed from the ignore and linted in future PRs
+packages/batch/README.md
+packages/commons/README.md
+packages/idempotency/README.md
+packages/jmespath/README.md
+packages/logger/README.md
+packages/metrics/README.md
+packages/parameters/README.md
+packages/parser/README.md
+packages/tracer/README.md

CODE_OF_CONDUCT.md

@@ -1,4 +1,5 @@
-## Code of Conduct
+# Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
+<[email protected]> with any additional questions or comments.

CONTRIBUTING.md

@@ -1,40 +1,44 @@
+# Contributing Guidelines <!-- omit in toc -->
+
 ## Table of contents <!-- omit in toc -->
 
 - [Reporting Bugs/Feature Requests](#reporting-bugsfeature-requests)
 - [Contributing via Pull Requests](#contributing-via-pull-requests)
-  - [Dev setup](#dev-setup)
-    - [Gitpod](#gitpod)
-    - [GitHub Codespaces](#github-codespaces)
-    - [Local environment](#local-environment)
-  - [Sending a pull request](#sending-a-pull-request)
-  - [Local documentation](#local-documentation)
+    - [Dev setup](#dev-setup)
+        - [Gitpod](#gitpod)
+        - [GitHub Codespaces](#github-codespaces)
+        - [Local environment](#local-environment)
+    - [Sending a pull request](#sending-a-pull-request)
+    - [Local documentation](#local-documentation)
 - [Conventions](#conventions)
-  - [General terminology and practices](#general-terminology-and-practices)
-  - [Testing definition](#testing-definition)
+    - [General terminology and practices](#general-terminology-and-practices)
+    - [Testing definition](#testing-definition)
 - [Finding contributions to work on](#finding-contributions-to-work-on)
 - [Code of Conduct](#code-of-conduct)
 - [Security issue notifications](#security-issue-notifications)
 - [Licensing](#licensing)
 
-# Contributing Guidelines <!-- omit in toc -->
-
+<!-- markdownlint-disable MD013 -->
 Thank you for your interest in contributing to our project. Whether it's a [bug report](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new?assignees=&labels=type%2Fbug%2Ctriage&projects=aws-powertools%2F7&template=bug_report.yml&title=Bug%3A+TITLE), [new feature](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new?assignees=&labels=type%2Ffeature-request%2Ctriage&projects=aws-powertools%2F7&template=feature_request.yml&title=Feature+request%3A+TITLE), [correction](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose), or [additional documentation](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new?assignees=&labels=area%2Fdocumentation%2Ctriage&projects=aws-powertools%2F7&template=documentation_improvements.yml&title=Docs%3A+TITLE), we greatly value feedback and contributions from our community.
+<!-- markdownlint-enable MD013 -->
 
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
 
 ## Reporting Bugs/Feature Requests
 
 We welcome you to use the GitHub issue tracker to report bugs, suggest features, or documentation improvements.
 
+<!-- markdownlint-disable MD013 -->
 [When filing an issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose), please check [existing open](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc), or [recently closed](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.
+<!-- markdownlint-enable MD013 -->
 
 ## Contributing via Pull Requests
 
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
 1. You are working against the latest source on the **main** branch, unless instructed otherwise.
 2. You check existing open, and recently merged pull requests to make sure someone else hasn't addressed the problem already.
-3. You discuss and agree your proposed changes under [an existing issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aopen+is%3Aupdated-desc) or a [new issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose){target="_blank" rel="nofollow"} before you begin any implementation. We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
+3. You discuss and agree the proposed changes under [an existing issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aopen+is%3Aupdated-desc) or a new one before you begin any implementation. We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
 
 At a high level, these are the steps to get code merged in the repository - don't worry, nearly all of them are automated.
 
@@ -49,6 +53,7 @@ timeline
                                     : Local tests
 
     Pre-commit checks <br> (git commit)   : Code linting (standards)
+                                          : Markdown linting
 
     Pre-Pull Request <br> (git push)   : Tests (unit)
 
@@ -111,7 +116,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
 You might find useful to run both the documentation website and the API reference locally while contributing:
 
 - **Docs website**: `npm run docs-runLocalDocker`
-    * If this is your first time running the docs, you need to build the image: `npm run docs-buildDockerImage`
+    - If this is your first time running the docs, you need to build the image: `npm run docs-buildDockerImage`
 - **API reference**: `npm run docs-api-build-run`
 
 ## Conventions

MAINTAINERS.md

@@ -1,2 +1,4 @@
+<!-- markdownlint-disable MD041 -->
+
 > [!IMPORTANT]
-> Maintainers' playbook moved: https://docs.powertools.aws.dev/lambda/typescript/latest/maintainers/
+> Maintainers' playbook moved: <https://docs.powertools.aws.dev/lambda/typescript/latest/maintainers/>