Style(exporters, docs, examples): Fix docs by markdown linter

refs #DS-1100

.remarkignore

@@ -8,10 +8,7 @@ build
 
 # Temporary disabled packages
 # we will fix them incrementally
-demo
 docs
-examples
-exporters
 form-validations
 icons
 web-twig

.remarkrc.mjs

@@ -4,6 +4,8 @@ export default {
   ...config,
   plugins: [
     ...config.plugins,
+    'remark-frontmatter',
+
     // Values should increment by one from the first item
     // @see: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-ordered-list-marker-value
     ['remark-lint-ordered-list-marker-value', 'ordered'],

docs/postmortems/0000-00-00-template.md

@@ -55,7 +55,7 @@ issues and Pull Requests in the "Bug" column with the appropriate owners -->
 - Item B
 - Item C
 
-## Timeline (all times in CET/CEST)
+## Timeline (all Times in CET/CEST)
 
 2024-01-01
 

docs/postmortems/2024-02-05-deprecated-icon-rendering.md

@@ -46,7 +46,7 @@ This problem was detected multiple times by the developers and the support quest
 
 Also, the message appeared in the browser console and the server logs:
 
-```
+```bash
 Warning: Icon component is not supported in SSR without use of `html-react-parser`. Please install missing peer dependency.
 ```
 
@@ -88,7 +88,7 @@ issues and Pull Requests in the "Bug" column with the appropriate owners -->
 
 - Usage of the `warning` utility everywhere the deprecation is raised and the condition about the `production` environment ensures that the deprecation messages are raised only in the development environment.
 
-## Timeline (all times in CET/CEST)
+## Timeline (all Times in CET/CEST)
 
 2023-12-27
 

examples/next-with-app-router/README.md

@@ -1,4 +1,4 @@
-# Example Next.js application with app router
+# Example Next.js Application with App Router
 
 This application is used to demonstrate the configuration of a Next.js application with an App router for use with the Spirit Design System.
 

examples/next-with-pages-router/README.md

@@ -1,4 +1,4 @@
-# Example Next.js application with pages router
+# Example Next.js Application with Pages Router
 
 This application is used to demonstrate the configuration of a Next.js application with an App router for use with the Spirit Design System.
 

exporters/assets/README.md

@@ -2,13 +2,13 @@
 
 The Spirit Assets Exporter allows you to **export a list of images** in such a way that it can be immediately used in your production codebase. This specific exporter exports assets in generic fashion, as SVG format, without any additional formatting or generated support files.
 
-### Exporter Output
+## Exporter Output
 
 This exporter will render image assets defined inside one specific brand and will produce flat structure:
 
 ⚠️ We only output assets from `icons` directory.
 
-### Naming
+## Naming
 
 The names of icons will be constructed from the original name.
 

exporters/js/README.md

@@ -2,7 +2,7 @@
 
 [Supernova][supernova-studio] JS exporter made for Spirit Design System developed by [Alma Career (formerly LMC)][alma-career].
 
-## Token operations
+## Token Operations
 
 This exported does several operations with tokens:
 
@@ -26,7 +26,7 @@ Font Family Ebony has a different font weight mapping in Figma and in Adobe Font
 
 Tokens are sorted alphabetically by origin (Figma) name or by name (Supernova). Except Measures - sorted by name number and Other - sorted by value.
 
-## Outputs:
+## Outputs
 
 - borders.ts
 - colors.ts

exporters/scss/README.md

@@ -2,7 +2,7 @@
 
 [Supernova][supernova-studio] SCSS exporter made for Spirit Design System developed by [Alma Career (formerly LMC)][alma-career].
 
-## Token operations
+## Token Operations
 
 This exported does several operations with tokens:
 
@@ -26,7 +26,7 @@ Font Family Ebony has a different font weight mapping in Figma and in Adobe Font
 
 Tokens are sorted alphabetically by origin (Figma) name or by name (Supernova). Except Measures - sorted by name number and Other - sorted by value.
 
-## Outputs:
+## Outputs
 
 - \_borders.scss
 - \_colors.scss

exporters/tokens/README.md

@@ -2,7 +2,7 @@
 
 [Supernova][supernova-studio] tokens exporter made for Spirit Design System developed by [Alma Career (formerly LMC)][alma-career].
 
-## Token operations
+## Token Operations
 
 This exported does several operations with tokens:
 
@@ -26,7 +26,7 @@ Font Family Ebony has a different font weight mapping in Figma and in Adobe Font
 
 Tokens are sorted alphabetically by origin (Figma) name or by name (Supernova). Except Measures - sorted by name number and Other - sorted by value.
 
-## Outputs:
+## Outputs
 
 - \_borders.scss
 - \_colors.scss

package.json

@@ -93,6 +93,7 @@
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "remark-cli": "12.0.1",
+    "remark-frontmatter": "^5.0.0",
     "remark-lint-heading-capitalization": "1.2.0",
     "sass-loader": "14.2.1",
     "style-loader": "4.0.0",

yarn.lock

@@ -16382,6 +16382,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"fault@npm:^2.0.0":
+  version: 2.0.1
+  resolution: "fault@npm:2.0.1"
+  dependencies:
+    format: "npm:^0.2.0"
+  checksum: 10/c9b30f47d95769177130a9409976a899ed31eb598450fbad5b0d39f2f5f56d5f4a9ff9257e0bee8407cb0fc3ce37165657888c6aa6d78472e403893104329b72
+  languageName: node
+  linkType: hard
+
 "fb-watchman@npm:^2.0.0":
   version: 2.0.2
   resolution: "fb-watchman@npm:2.0.2"
@@ -16860,6 +16869,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"format@npm:^0.2.0":
+  version: 0.2.2
+  resolution: "format@npm:0.2.2"
+  checksum: 10/5f878b8fc1a672c8cbefa4f293bdd977c822862577d70d53456a48b4169ec9b51677c0c995bf62c633b4e5cd673624b7c273f57923b28735a6c0c0a72c382a4a
+  languageName: node
+  linkType: hard
+
 "formdata-polyfill@npm:^4.0.10":
   version: 4.0.10
   resolution: "formdata-polyfill@npm:4.0.10"
@@ -21681,6 +21697,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"mdast-util-frontmatter@npm:^2.0.0":
+  version: 2.0.1
+  resolution: "mdast-util-frontmatter@npm:2.0.1"
+  dependencies:
+    "@types/mdast": "npm:^4.0.0"
+    devlop: "npm:^1.0.0"
+    escape-string-regexp: "npm:^5.0.0"
+    mdast-util-from-markdown: "npm:^2.0.0"
+    mdast-util-to-markdown: "npm:^2.0.0"
+    micromark-extension-frontmatter: "npm:^2.0.0"
+  checksum: 10/afd9486af6ea74a94d84a225c367ab810ad4439683ecafc1ce9fc7bb0ecacaafac82e0af529974489c145824b242509f9387f833fc01a14a83a978049772ef80
+  languageName: node
+  linkType: hard
+
 "mdast-util-heading-style@npm:^3.0.0":
   version: 3.0.0
   resolution: "mdast-util-heading-style@npm:3.0.0"
@@ -21971,6 +22001,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"micromark-extension-frontmatter@npm:^2.0.0":
+  version: 2.0.0
+  resolution: "micromark-extension-frontmatter@npm:2.0.0"
+  dependencies:
+    fault: "npm:^2.0.0"
+    micromark-util-character: "npm:^2.0.0"
+    micromark-util-symbol: "npm:^2.0.0"
+    micromark-util-types: "npm:^2.0.0"
+  checksum: 10/55873937494e9bfe1cc8cba3c8710e14e85ad0c9f3bb859d367268fc2204f3fe2eb70f9f83e496de0d3ea79c468fe6df879f9d475c716644c2daa90056cc8374
+  languageName: node
+  linkType: hard
+
 "micromark-factory-destination@npm:^2.0.0":
   version: 2.0.0
   resolution: "micromark-factory-destination@npm:2.0.0"
@@ -26128,6 +26170,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"remark-frontmatter@npm:^5.0.0":
+  version: 5.0.0
+  resolution: "remark-frontmatter@npm:5.0.0"
+  dependencies:
+    "@types/mdast": "npm:^4.0.0"
+    mdast-util-frontmatter: "npm:^2.0.0"
+    micromark-extension-frontmatter: "npm:^2.0.0"
+    unified: "npm:^11.0.0"
+  checksum: 10/5d859f336e9cd6f6ed02139a76781b35a8cabbbb240d30dd8048e1c74d7b8e8335b98f27290c9787baab3bc5eb935347a046fa85ad307cf0f7ea6c1ecfde8dc4
+  languageName: node
+  linkType: hard
+
 "remark-lint-blockquote-indentation@npm:^4.0.0":
   version: 4.0.0
   resolution: "remark-lint-blockquote-indentation@npm:4.0.0"
@@ -28481,6 +28535,7 @@ __metadata:
     react: "npm:18.3.1"
     react-dom: "npm:18.3.1"
     remark-cli: "npm:12.0.1"
+    remark-frontmatter: "npm:^5.0.0"
     remark-lint-heading-capitalization: "npm:1.2.0"
     sass-loader: "npm:14.2.1"
     style-loader: "npm:4.0.0"