diff --git a/.remarkignore b/.remarkignore index 1dee1c84dd..a5104f5e7a 100644 --- 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 index afcca290e0..75c1aff7fc 100644 --- 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 index e9f8281970..3ca4a20490 100644 --- a/configs/jest-config-spirit/README.md +++ b/configs/jest-config-spirit/README.md @@ -1,8 +1,11 @@ + + + # 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 + + + ### `jest-preset-spirit/node` The default Jest configuration for Node.js projects. + + + ### `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 index 2866daac57..f59707097d 100644 --- a/configs/prettier-config-spirit/README.md +++ b/configs/prettier-config-spirit/README.md @@ -1,8 +1,11 @@ + + + # 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 index e43207c14c..57bed994d9 100644 --- a/configs/stylelint-config-spirit/README.md +++ b/configs/stylelint-config-spirit/README.md @@ -1,8 +1,11 @@ + + + # 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 index 25390ade40..5e92e374ab 100644 --- 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 index e26e7b897b..12b3b287a4 100644 --- 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 -.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 index 5091cabe06..a7974e9581 100644 --- a/packages/demo/README.md +++ b/packages/demo/README.md @@ -1,3 +1,6 @@ + + + # @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 index 9c63d2f51e..ff315a839f 100644 --- a/packages/design-tokens/README.md +++ b/packages/design-tokens/README.md @@ -1,3 +1,6 @@ + + + # @lmc-eu/spirit-design-tokens > Design tokens for Spirit Design System. @@ -154,9 +157,12 @@ module: { -##### Using the sass-embedded Library + + + +#### 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:
How do I derive design tokens for my own design system? + + **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 index 4296d6a90b..4824922c7f 100644 --- 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 + + + ### 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 index 529ca13de6..478a558524 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -1,10 +1,8 @@ - - + + # @lmc-eu/spirit-web - - > 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