webments-neumorphic
v0.2.1
Published
Webments Neumorphic design library.
Downloads
2
Readme
neumorphic.css is a lightweight, responsive and modern CSS framework.
- Lightweight (~x gzipped), blazing fast.
- Flexbox-based, responsive and mobile-friendly layout
- Elegantly designed and developed elements and components
Table of Contents
- Getting started
- Documentation and Usage
- Compatibility
- Contributing
- Contributors
- Community
- Versioning
- Copyright and License
Getting started
neumorphic.css is available via either npm (preferred), Yarn, or a CDN.
NPM
- Obtain the package via NPM
npm i webments-neumorphic
- Insert the line below to your head area in your HTML file
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" type="text/css" href="node_modules/webments-neumorphic/dist/css/neumorphic.css" />
</head>
<body></body>
</html>
Yarn
- Obtain the package via yarn
yarn add webments-neumorphic
- Insert the line below to your head area in your HTML file
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" type="text/css" href="node_modules/webments-neumorphic/dist/css/neumorphic.css" />
</head>
<body></body>
</html>
CDN
- Obtain the stylesheet via unpkg.com CDN. The latest option automatically uses the latest release version which might include radical and important changes such as class name changes which may result in broken styles in your projects. You might want to consider using a version-specific release.
Latest (stable channel, automatically updated)
https://unpkg.com/webments-neumorphic@latest/dist/css/neumorphic.css
Version-specific (stable channel, not automatically updated)
https://unpkg.com/[email protected]/dist/css/neumorphic.css
If the URL above (version-specific link) not working for you, try replacing @0.2.0 with the latest released version (in case we forgot replacing).
- Import the CDN from your head area in your HTML file
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" type="text/css" href="https://unpkg.com/webments-neumorphic/dist/css/neumorphic.css" />
</head>
<body></body>
</html>
You can load a specific version listed in the releases section in this repository like in the example above.
Documentation and Usage
neumorphic.css and all other Webments frameworks only provide components based on their design languages.
You can see previews and learn about component usages (documentation) here.
After installing with your favorite method, you can start using the library using the components from the preview page, index.html (same class names are a must per CSS declaration).
Compatibility
neumorphic.css is compatible and has been tested with recent versions of
- Chrome
- Edge
- Firefox
- Opera
- Safari
- Internet Explorer (partially supported)
The compatibility information above is based on our test and research information and doesn't mean that it won't work with other browsers.
Contributing
All Webments frameworks are open to contributions from everyone! You can fork the repository, make your changes, and submit as pull requests to help improve them. Make sure to read the Code of Conduct and the Contributing guide before submitting contributions. You can also check out the necessary license information.
Community
Enjoying neumorphic.css? Join our community to discuss about features, improvements and more!
Versioning
This framework is maintained under the Semantic Versioning guidelines.
Copyright and License
Code and documentation Copyright 2020 The Webments Maintainers and Contributors, Code released under the LGPL-2.1 (GNU Lesser General Public License v2.1) License.