myds-style

The Malaysian Government Design System (MYDS) is an open-source design system to build products for the Malaysian government. It contains the design guideline and the component library for creating consistent and accessible digital services.

Getting started

To install @govtechmy/myds-style in your project, run the installation command for the package manager of your choice:

# npm
npm i @govtechmy/myds-style

# yarn
yarn add @govtechmy/myds-style

# pnpm
pnpm add @govtechmy/myds-style

Usage

The package provides styling necessary to support MYDS implementation for your project. Using it is as simple as:

A. Import via CSS

/* Place in the CSS entry point */
@import "@govtechmy/myds-tailwindcss/full.css";

B. Import via JS (Bundler)

// Place in the bundle entry point (eg. index.{ts,js})
import "@govtechmy/myds-tailwindcss/full.css";

MYDS is an open-source project and welcomes contributions from the public. To contribute:

1. Discuss New Features: Before submitting a pull request (PR), please open an issue to discuss the feature you would like to add or change. This helps to ensure that your contribution aligns with the project's goals and guidelines.
2. Submit a PR: Once the feature has been discussed and approved, you can submit a PR with your changes. Please follow the contribution guidelines provided in the repository.

We look forward to collaborating with you to improve MYDS.