Clay is Liferay's web implementation of the Lexicon Experience Language. Built with Bootstrap as a foundation, it's comprised of HTML, CSS, and JS.
Clay repository follows the monorepo approach, all the major components that are the pillars of Clay are here in this repository.
Clay CSS: The pillar to give colors and structure to Clay, where is the css and examples of HTML markups of the components.
clayui.com: The source code for our documentation site.
You can find the Clay documentation on the site. Here are some useful links:
To contribute to this project, here are the required steps to setup everything:
- Clone this repository:
git clone https://github.com/liferay/clay.git
Download and install the latest lts version of Node.js for your operating system.
Install the required global dependencies:
npm install -g yarn
- Install the project's dependencies:
- Install the dependencies for each package and link them together:
- Build all packages:
- Compile all
clay-cssfiles and start the storybook server:
yarn workspace @clayui/css run build && yarn storybook
Additionally, you can run the tests for all packages with the following command:
To contribute to the documentation, you can run the site locally to test your changes:
- Navigate to the site's directory:
- Install the dependencies:
- Run the site in a development environment:
If you want to test in a production environment so that you do not take risks of inconsistencies, issue the following command in the root directory:
Feel free to create issues or submit pull requests. Clay is actively maintained and your contributions are always welcome.
Before opening a issue make sure it exists.
See the contribution guide for more details.
BSD License © Liferay, Inc.