Skip to content

Commit

Permalink
Style(icons): Fix docs by markdown linter
Browse files Browse the repository at this point in the history
refs #DS-1100
  • Loading branch information
literat committed Dec 11, 2024
1 parent 1915a9f commit ebf62f1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
1 change: 0 additions & 1 deletion .remarkignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,5 @@ build
# we will fix them incrementally
docs
form-validations
icons
web-twig
web-react
20 changes: 12 additions & 8 deletions packages/icons/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint ignore heading-capitalization-->

# @lmc-eu/spirit-icons

> Icons of Spirit Design System.
## Install

πŸ™‹πŸ»β€β™‚οΈ **Hold on! Do you already use [`spirit-web`]?** Then you don't need to
πŸ™‹πŸ»β€β™‚οΈ **Hold on! Do you already use [`spirit-web`][spirit-web]?** Then you don't need to
install this package because `spirit-icons` is installed automatically
as a dependency of [`spirit-web`].
as a dependency of [`spirit-web`][spirit-web].

If you want to use just `spirit-icons` alone in your project, run:

Expand All @@ -28,13 +31,13 @@ or themself.

## Usage

### SVG files
### SVG Files

You can use SVG files directly from `@lmc-eu/spirit-icons/svg` directory by importing them or copying them to your app structure.

### React

You can import SVG files directly from `@lmc-eu/spirit-icons/svg` directory in React components using a library like [React SVGR](https://react-svgr.com/).
You can import SVG files directly from `@lmc-eu/spirit-icons/svg` directory in React components using a library like [React SVGR][react-svgr].

Example configuration for Webpack:

Expand Down Expand Up @@ -64,7 +67,7 @@ import WarningIcon from '@lmc-eu/spirit-icons/react/WarningIcon';
<WarningIcon />;
```

### Icons paths
### Icons Paths

Alternatively you can use an `icons` object which consists of an icon name and SVG content. Thus you can fabricate your icon yourself.

Expand Down Expand Up @@ -99,7 +102,8 @@ export default nextConfig;

This configuration is not required if you are using the Next.js App Router.

For more information, please see the [Next.js documentation][nextjs-transpilePackages].
For more information, please see the [Next.js documentation][nextjs-transpile-packages].

[`spirit-web`]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web
[nextjs-transpilePackages]: https://nextjs.org/docs/pages/api-reference/next-config-js/transpilePackages
[spirit-web]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web
[nextjs-transpile-packages]: https://nextjs.org/docs/pages/api-reference/next-config-js/transpilePackages
[react-svgr]: https://react-svgr.com/

0 comments on commit ebf62f1

Please sign in to comment.