113 lines
7.3 KiB
Markdown
113 lines
7.3 KiB
Markdown
|
|
|
|
# Fomantic-UI
|
|
The official community fork of the popular Semantic-UI framework.
|
|
|
|
[](https://github.com/fomantic/Fomantic-UI/actions)
|
|
[](https://github.com/fomantic/Fomantic-UI/commits/develop)
|
|
[](https://github.com/fomantic/Fomantic-UI/blob/1fd94d2479f297c906bed557f0567d1d3f0a4d2c/LICENSE.md)
|
|
|
|
[](https://discord.gg/YChxjJ3)
|
|
[](https://twitter.com/fomanticui)
|
|
|
|
[](https://www.npmjs.com/package/fomantic-ui)
|
|
[](https://www.npmjs.com/package/fomantic-ui)
|
|
|
|
[](https://www.jsdelivr.com/package/npm/fomantic-ui)
|
|
[](https://cdnjs.com/libraries/fomantic-ui)
|
|
|
|
[](https://github.com/fomantic/Fomantic-UI/actions/workflows/ci.yml)
|
|
[](https://github.com/fomantic/Fomantic-UI/actions/workflows/nightly.yml)
|
|
|
|
[](https://packagequality.com/#?package=fomantic-ui)
|
|
[](https://github.com/fomantic/Fomantic-UI/graphs/contributors)
|
|
[](https://github.com/features/security)
|
|
[](https://snyk.io/test/github/fomantic/Fomantic-UI?targetFile=package.json)
|
|
[](https://bestpractices.coreinfrastructure.org/projects/7496)
|
|
|
|
---
|
|
|
|
> *NOTE:* Fomantic was created to continue active development of Semantic-UI and has the intent to be merged back into the master repository once active development can restart. For more info please read the following issues https://github.com/Semantic-Org/Semantic-UI/issues/6109 https://github.com/Semantic-Org/Semantic-UI/issues/6413
|
|
>
|
|
> *EDIT:* Lots has changed since we started this project and we are now starting the development of FUI v3. You can read more about the v3 proposals [here](https://github.com/fomantic/Fomantic-UI/issues/319).
|
|
>
|
|
> To be clear merging back into SUI is still our intention, read [this comment](https://github.com/fomantic/Fomantic-UI/issues/319#issuecomment-461736399) for more info
|
|
|
|
---
|
|
|
|
Fomantic allows developers to build beautiful websites fast, with **concise HTML**, **intuitive javascript**, and **simplified debugging**, helping make front-end development a delightful experience. Fomantic is responsively designed allowing your website to scale on multiple devices.
|
|
|
|
## 📡 Installation
|
|
|
|
```bash
|
|
$ npm install fomantic-ui
|
|
```
|
|
|
|
Living on the edge? Try our nightly build and test new features and bug fixes early!
|
|
```bash
|
|
$ npm install fomantic-ui@nightly
|
|
```
|
|
|
|
Fomantic includes an interactive installer to help setup your project.
|
|
|
|
* For more details on setup visit our [getting started guide](https://fomantic-ui.com/introduction/getting-started.html).
|
|
* To learn more about theming please read our [theming guide](https://fomantic-ui.com/usage/theming.html)
|
|
|
|
### 💻 Browser Support
|
|
|
|
* Last 2 Versions of Firefox, Chrome, Safari Mac, Edge
|
|
* Last 4 Versions of Android, Chrome for Android, iOS Safari[^1]
|
|
* IE 11[^2]
|
|
* Microsoft Edge 12-44[^2]
|
|
|
|
[^1]: Fomantic-UI should basically still work in iOS Safari 9+, Android 6+, but, starting from v2.9.0, we won't support them anymore if anything works different than in recent versions.
|
|
[^2]: Fomantic-UI should basically still work in IE11 / old Edge, but, starting from v2.9.0, we won't support them anymore in terms of dedicated bugfixes.
|
|
|
|
---
|
|
|
|
## 📦 Other packages
|
|
|
|
| Environment | Install Command | Repository | Third-Party |
|
|
|-------------|---------------------------------------|------------------------------------------------------------------|-------------|
|
|
| CSS Only | `npm install fomantic-ui-css` | [Fomantic-UI-CSS](https://github.com/fomantic/Fomantic-UI-CSS) | |
|
|
| LESS | `npm install fomantic-ui-less` | [Fomantic-UI-LESS](https://github.com/fomantic/Fomantic-UI-LESS) | |
|
|
| SASS | `gem 'fomantic-ui-sass'` | [Fomantic-UI-SASS](https://github.com/fomantic/Fomantic-UI-SASS) | ✅ |
|
|
|
|
---
|
|
|
|
## 💬 Community
|
|
|
|
### 💡 Getting Help
|
|
|
|
If you're looking for help with an issue we offer multiple ways for you to get support. You can post usage questions here on GitHub
|
|
or you can ask in our community [Discord](https://discord.gg/YChxjJ3) server.
|
|
|
|
### 🐛 Submitting Bugs and Enhancements
|
|
[GitHub Issues](https://github.com/fomantic/Fomantic-UI/issues) is for suggesting enhancements and reporting bugs. Before submitting a bug make sure you do the following:
|
|
* Check to see if the issue has already been raised.
|
|
* [Fork this boilerplate JSFiddle](https://jsfiddle.net/31d6y7mn) to create a reproducible example of the bug. If a bug is apparent in the docs you can simply link to the docs example, just make it clear exactly how to reproduce the issue. Only bugs that include a test case can be triaged.
|
|
* If submitting an enhancement try and create it in the [JSFiddle](https://jsfiddle.net/31d6y7mn) if not it's fine but explain clearly what you want.
|
|
|
|
### 📝 Pull Requests
|
|
|
|
Before creating a pull request be sure to read the [Contributing Guide](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md), this is where we explain everything you need to know about contributing to Fomantic.
|
|
|
|
## Sponsors
|
|
|
|
### Infrastructure hosted and powered by [DigitalOcean](https://www.digitalocean.com/?utm_medium=opensource&utm_source=fomantic)
|
|
[](https://www.digitalocean.com/?utm_medium=opensource&utm_source=fomantic)
|
|
|
|
Sign up now and get $100 in credit for 60 days! [Sign up here!](https://m.do.co/c/bece3e1afb7f)
|
|
|
|
|
|
### Cross-browser testing provided by [BrowserStack](https://www.browserstack.com)
|
|
[](https://www.browserstack.com)
|
|
|
|
|
|
### IDE's provided by [JetBrains](https://www.jetbrains.com?from=Fomantic-UI)
|
|
[](https://www.jetbrains.com?from=Fomantic-UI)
|
|
|
|
---
|
|
|
|
#### Credit
|
|
Semantic-UI was beautifully crafted by [@jlukic](https://github.com/jlukic)
|