{"id":22278994,"url":"https://github.com/marklogic/design-system","last_synced_at":"2025-07-28T18:31:03.594Z","repository":{"id":44271074,"uuid":"240357598","full_name":"marklogic/design-system","owner":"marklogic","description":"MarkLogic Engineering UX design system","archived":false,"fork":false,"pushed_at":"2023-05-08T00:50:09.000Z","size":10331,"stargazers_count":2,"open_issues_count":11,"forks_count":8,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-04-26T03:20:48.666Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marklogic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-13T20:47:13.000Z","updated_at":"2021-04-27T23:39:21.000Z","dependencies_parsed_at":"2022-08-24T23:53:47.115Z","dependency_job_id":null,"html_url":"https://github.com/marklogic/design-system","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic%2Fdesign-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic%2Fdesign-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic%2Fdesign-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic%2Fdesign-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marklogic","download_url":"https://codeload.github.com/marklogic/design-system/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227647758,"owners_count":17798596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-03T15:17:42.307Z","updated_at":"2024-12-03T15:17:42.892Z","avatar_url":"https://github.com/marklogic.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkLogic UI Component Library\nReact component library that extends Ant Design.\n\n## Installing the Library\n\n```\nnpm install --save marklogic-ui-library\n```\n\n## Using the Component Library\n\n- Setup your application repo to handle custom Ant Design theming https://ant.design/docs/react/use-with-create-react-app#Advanced-Guides\n- Copy config-overrides.js from /playground into application repo\n- Add Ant Design CSS file to app: '../node_modules/antd/dist/antd.css';\n- Add minifed Marklogic UI CSS file to app:  path to '../node_modules/marklogic-ui-library/dist/styles.min.css'\n\n```jsx\nimport React from 'react'\n\nimport { MlButton } from 'marklogic-ui-library';\n\nconst App = () =\u003e {\n  return (\n    \u003cMlButton\u003eSubmit\u003c/MlButton\u003e\n  )\n}\n```\n\n## Developing UI Components\n\n``` \n# Install Dependencies\nnpm run install:all \n\n# Start Rollup (listens for changes for components in src folder)\nroot directory\nnpm start\n\n# Start Playground (import and test new components here)\ncd playground\nnpm start\n\nPlayground: localhost:3000\n\n```\n- Add new components in the root/src folder \n- Add CSS to root/src/styles.scss file\n- Import/Export component in root/src/index.js\n- Create Stories for the component in the root/stories folder\n\n## Viewing UI Components\nThis repo uses Storybook to view components and provide usage guidelines and API documentation\n```\n# Install Dependencies\nnpm run install:all \n\n# Start Storybook\nnpm run storybook\n\nStorybook: localhost:6006 \n```\n\n## Publishing static version of Storybook\n```\n# Build Storybook\nnpm run build-storybook\n\nStatic files will be in the /storybook-dist folder\n```\n\n\n## Publishing the Library to NPM\nMake sure you are logged in to npm\n``` \nUpdate root/package.json\nversion needs to increase everytime it is published.\n\n# Build minified CSS and publish library to NPM\nnpm publish\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarklogic%2Fdesign-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarklogic%2Fdesign-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarklogic%2Fdesign-system/lists"}