Style(common, codemods, analytics, design-tokens): Fix docs by markdo…

…wn linter
lmc-eu · Dec 11, 2024 · f5941f7 · f5941f7
1 parent 6cc4a43
commit f5941f7
Show file tree

Hide file tree

Showing 11 changed files with 52 additions and 20 deletions.
diff --git a/.remarkignore b/.remarkignore
@@ -8,11 +8,6 @@ build
 
 # Temporary disabled packages
 # we will fix them incrementally
-analytics
-codemods
-common
-configs
-design-tokens
 demo
 docs
 examples

diff --git a/.remarkrc.mjs b/.remarkrc.mjs
@@ -35,7 +35,18 @@ export default {
     [
       'remark-lint-heading-capitalization',
       {
-        lowerCaseWords: ['eu/spirit', '@lmc', 'spirit/node', 'spirit/jsdom', 'v1', 'v2', 'v3'],
+        lowerCaseWords: [
+          'eu/spirit',
+          '@lmc',
+          'spirit/node',
+          'spirit/jsdom',
+          'analytics',
+          'codemods',
+          'common',
+          'v1',
+          'v2',
+          'v3',
+        ],
       },
     ],
   ],

diff --git a/configs/jest-config-spirit/README.md b/configs/jest-config-spirit/README.md
@@ -1,8 +1,11 @@
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 # jest-config-spirit
 
 > Jest configuration and preset for Spirit Design System
 
-## Getting started
+## Getting Started
 
 This preset is part of this monorepo only and thus it is accessible for every package.
 
@@ -14,10 +17,16 @@ yarn add jest-config-spirit
 
 ## ⚙️ Configurations
 
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 ### `jest-preset-spirit/node`
 
 The default Jest configuration for Node.js projects.
 
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 ### `jest-preset-spirit/jsdom`
 
 The extension of the default preset for projects that require a browser-like (DOM) environment.

diff --git a/configs/prettier-config-spirit/README.md b/configs/prettier-config-spirit/README.md
@@ -1,8 +1,11 @@
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 # prettier-config-spirit
 
 > Prettier configuration and preset for Spirit Design System
 
-## Getting started
+## Getting Started
 
 This preset is part of this monorepo only and thus it is accessible for every package.
 

diff --git a/configs/stylelint-config-spirit/README.md b/configs/stylelint-config-spirit/README.md
@@ -1,8 +1,11 @@
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 # stylelint-config-spirit
 
 > Stylelint configuration and preset for Spirit Design System
 
-## Getting started
+## Getting Started
 
 This preset is part of this monorepo only and thus it is accessible for every package.
 

diff --git a/packages/analytics/README.md b/packages/analytics/README.md
@@ -35,7 +35,7 @@ By default, the output will be saved into the `.scanner` directory, but you can
 spirit-analytics --output path/to/folder
 ```
 
-The [react-scanner] requires a [config file][react-scanner-config] to make it work, `spirit-analytics` has a default config inside, but if you need to, you can use your own config:
+The [react-scanner][react-scanner] requires a [config file][react-scanner-config] to make it work, `spirit-analytics` has a default config inside, but if you need to, you can use your own config:
 
 ```shell
 spirit-analytics --config path/to/config

diff --git a/packages/codemods/CONTRIBUTING.md b/packages/codemods/CONTRIBUTING.md
@@ -15,9 +15,9 @@ Codemods adhere to a clear and organized naming convention, following the kebab
 
 This naming convention ensures consistency and ease of understanding, facilitating seamless integration and maintenance of codemods within the project.
 
-### Example naming
+### Example Naming
 
-```
+```text
 <component-name>-<purpose-of-codemod>.ts
         |                 |
         |                 └─⫸ Codemod purpose
@@ -29,7 +29,7 @@ This naming convention ensures consistency and ease of understanding, facilitati
 
 The file structure below outlines a standard organization for codemods within the project:
 
-```
+```text
 ─── src
     └── transforms
         └── v2

diff --git a/packages/demo/README.md b/packages/demo/README.md
@@ -1,3 +1,6 @@
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 # @lmc-eu/spirit-demo
 
 > Scripts, Styles and Partials for showcase apps of Spirit Design System.

diff --git a/packages/design-tokens/README.md b/packages/design-tokens/README.md
@@ -1,3 +1,6 @@
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 # @lmc-eu/spirit-design-tokens
 
 > Design tokens for Spirit Design System.
@@ -154,9 +157,12 @@ module: {
 
 </details>
 
-##### Using the sass-embedded Library
+<!-- https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
+#### Using the `sass-embedded` Library
 
-If you're using `sass-embedded`, you can specify the API as `legacy`, `modern`, or `modern-compiler`. More information can be found in [sass documentation](sass-embedded).
+If you're using `sass-embedded`, you can specify the API as `legacy`, `modern`, or `modern-compiler`. More information can be found in [sass documentation][sass-embedded].
 
 We recommend using the `modern-compiler` option.
 Please note that this change also requires updating `includePaths` to `loadPaths`.
@@ -300,6 +306,8 @@ With `@` prefix:
 <details>
 <summary>How do I derive design tokens for my own design system?</summary>
 
+<!--lint ignore no-emphasis-as-heading-->
+
 **Creating a custom design system derived from Spirit? Great to hear that! 🎉**
 
 While it's perfectly OK to develop custom components that may not find their way

diff --git a/packages/web/DEPRECATIONS.md b/packages/web/DEPRECATIONS.md
@@ -6,6 +6,9 @@ This document lists all deprecations that will be removed in the next major vers
 
 ## Deprecations
 
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization-->
+
 ### Collapse `data-spirit-is-disposable`
 
 The `data-spirit-more` attribute was removed, please use `data-spirit-is-disposable` instead.

diff --git a/packages/web/README.md b/packages/web/README.md
@@ -1,10 +1,8 @@
-<!-- @see: https://github.com/ilyatitovich/remark-lint-heading-capitalization/issues/13 -->
-<!--lint disable heading-capitalization -->
+<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
+<!--lint ignore heading-capitalization -->
 
 # @lmc-eu/spirit-web
 
-<!--lint enable heading-capitalization -->
-
 > CSS implementation of Spirit Design System.
 
 ## Install
@@ -260,7 +258,6 @@ Check your browser console to see if you are using any of the deprecated functio
 See the [LICENSE][license] file for information.
 
 [all-deprecations]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web/DEPRECATIONS.md
-[configuring-load-path]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/design-tokens#configuring-load-path
 [deprecations]: https://github.com/lmc-eu/spirit-design-system/blob/main/static/deprecations-browser-console.png?raw=true
 [design-tokens-usage]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/design-tokens#basic-usage
 [design-tokens-load-path]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/design-tokens#in-sass