Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webments/neumorphic.css
Neumorphic CSS framework by Webments. (WIP)
https://github.com/webments/neumorphic.css
css css-framework css3 framework framework-css frameworks frontend frontend-web neumorphic neumorphic-css neumorphic-design neumorphic-elements neumorphic-ui webments webments-neumorphic
Last synced: 3 days ago
JSON representation
Neumorphic CSS framework by Webments. (WIP)
- Host: GitHub
- URL: https://github.com/webments/neumorphic.css
- Owner: webments
- License: lgpl-2.1
- Created: 2020-04-25T14:19:13.000Z (over 4 years ago)
- Default Branch: development
- Last Pushed: 2020-05-21T23:40:43.000Z (over 4 years ago)
- Last Synced: 2024-09-04T07:41:43.396Z (24 days ago)
- Topics: css, css-framework, css3, framework, framework-css, frameworks, frontend, frontend-web, neumorphic, neumorphic-css, neumorphic-design, neumorphic-elements, neumorphic-ui, webments, webments-neumorphic
- Language: CSS
- Homepage: https://webments.github.io/neumorphic.css/docs
- Size: 3.07 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
neumorphic.css
by Webments
Neumorphic is a futuristic design metaphor and language.
Warning: Work in progress, do NOT use.
neumorphic.css is a lightweight, responsive and modern CSS framework.
- Lightweight (~1.51kB minzipped), blazing fast.
- Flexbox-based, responsive and mobile-friendly layout
- Elegantly designed and developed elements and components
## Table of Contents
- [Getting started](#gettingstarted)
- [Documentation and Usage](#usage)
- [Compatibility](#compatibility)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [Community](#community)
- [Versioning](#versioning)
- [Copyright and License](#license)
## Getting started
neumorphic.css is available via either NPM (preferred), Yarn, or a CDN.
### NPM
1. Obtain the package via NPM
```shell
npm i webments-neumorphic
```
2. Insert the line below to your head area in your HTML file
```html
```
---
### Yarn
1. Obtain the package via Yarn
```shell
yarn add webments-neumorphic
```
2. Insert the line below to your head area in your HTML file
```html
```
---
### CDN
1. 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.min.css
```
#### Version-specific (stable channel, not automatically updated)
```
https://unpkg.com/webments-neumorphic@[latest_version]/dist/css/paper.min.css
```
> Make sure to replace latest_version to the latest available version [from the npm package manager](https://www.npmjs.com/package/webments-neumorphic) (without the brackets!)
e.g. `https://unpkg.com/[email protected]/dist/css/paper.min.css` (version number not up to date, shown as example)
2. Import the CDN from your head area in your HTML file
```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](https://webments.github.io/neumorphic.css/).
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](https://github.com/Webments/neumorphic.css/fork), make your changes, and submit as pull requests to help improve them. Make sure to read the [Code of Conduct](https://github.com/Webments/neumorphic.css/blob/master/CODE_OF_CONDUCT.md) and the [Contributing guide](https://github.com/Webments/neumorphic.css/blob/master/CONTRIBUTING.md) before submitting contributions. You can also check out the necessary [license information](https://github.com/Webments/neumorphic.css/blob/master/LICENSE).
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Arda Çebi
💻 🎨 📖
Baran Önen
💻 🎨
Tan A.
💻 🎨
## Community
Enjoying neumorphic.css? Join our community to discuss about features, improvements and more!
- [Visit GitHub organization](https://github.com/Webments)
- [Join Telegram group](https://t.me/Webments)
This framework is maintained under the [Semantic Versioning guidelines](https://semver.org/).
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.
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!