| 1 | 
|
| 2 |
|
| 3 | # Fomantic-UI
|
| 4 | A community fork of the popular Semantic-UI framework.
|
| 5 |
|
| 6 | [](https://github.com/fomantic/Fomantic-UI/actions)
|
| 7 | [](https://github.com/fomantic/Fomantic-UI/commits/develop)
|
| 8 | [](https://github.com/fomantic/Fomantic-UI/blob/1fd94d2479f297c906bed557f0567d1d3f0a4d2c/LICENSE.md)
|
| 9 |
|
| 10 | [](https://discord.gg/YChxjJ3)
|
| 11 | [](https://twitter.com/fomanticui)
|
| 12 |
|
| 13 | [](https://www.npmjs.com/package/fomantic-ui)
|
| 14 | [](https://www.npmjs.com/package/fomantic-ui)
|
| 15 |
|
| 16 | [](https://www.jsdelivr.com/package/npm/fomantic-ui)
|
| 17 | [](https://cdnjs.com/libraries/fomantic-ui)
|
| 18 |
|
| 19 | [](https://packagequality.com/#?package=fomantic-ui)
|
| 20 | [](https://github.com/fomantic/Fomantic-UI/graphs/contributors)
|
| 21 | [](https://dependabot.com)
|
| 22 | [](https://snyk.io/test/github/fomantic/Fomantic-UI?targetFile=package.json)
|
| 23 |
|
| 24 | ---
|
| 25 |
|
| 26 | > *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
|
| 27 | >
|
| 28 | > *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).
|
| 29 | >
|
| 30 | > 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
|
| 31 |
|
| 32 | ---
|
| 33 |
|
| 34 | 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.
|
| 35 |
|
| 36 | ## 📡 Installation
|
| 37 |
|
| 38 | ```bash
|
| 39 | $ npm install fomantic-ui
|
| 40 | ```
|
| 41 |
|
| 42 | Living on the edge? Try our nightly build and test new features and bug fixes early!
|
| 43 | ```bash
|
| 44 | $ npm install fomantic-ui@nightly
|
| 45 | ```
|
| 46 |
|
| 47 | Fomantic includes an interactive installer to help setup your project.
|
| 48 |
|
| 49 | * For more details on setup visit our [getting started guide](http://fomantic-ui.com/introduction/getting-started.html).
|
| 50 | * To learn more about theming please read our [theming guide](http://fomantic-ui.com/usage/theming.html)
|
| 51 |
|
| 52 | ### 💻 Browser Support
|
| 53 |
|
| 54 | * Last 2 Versions FF, Chrome, Safari Mac
|
| 55 | * IE 11+
|
| 56 | * Android 4.4+, Chrome for Android 44+
|
| 57 | * iOS Safari 7+
|
| 58 | * Microsoft Edge 12+
|
| 59 |
|
| 60 | Although some components will work in IE9, [grids](http://semantic-ui.com/collections/grid.html) and other [flexbox](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Flexible_boxes) components are not supported by IE9 and may not appear correctly.
|
| 61 |
|
| 62 | ---
|
| 63 |
|
| 64 | ## 📦 Other packages
|
| 65 |
|
| 66 | | Environment | Install Command | Repository | Third-Party |
|
| 67 | |-------------|---------------------------------------|------------------------------------------------------------------|-------------|
|
| 68 | | CSS Only | `npm install fomantic-ui-css` | [Fomantic-UI-CSS](https://github.com/fomantic/Fomantic-UI-CSS) | |
|
| 69 | | LESS | `npm install fomantic-ui-less` | [Fomantic-UI-LESS](https://github.com/fomantic/Fomantic-UI-LESS) | |
|
| 70 | | SASS | `gem 'fomantic-ui-sass'` | [Fomantic-UI-SASS](https://github.com/fomantic/Fomantic-UI-SASS) | ✅ |
|
| 71 |
|
| 72 | ---
|
| 73 |
|
| 74 | ## 💬 Community
|
| 75 |
|
| 76 | ### 💡 Getting Help
|
| 77 |
|
| 78 | If your looking for help with an issue we offer multiple ways for you to get support. You can post usage questions here on GitHub
|
| 79 | or you can ask in our community [Discord](https://discord.gg/YChxjJ3) server.
|
| 80 |
|
| 81 | ### 🐛 Submitting Bugs and Enhancements
|
| 82 | [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:
|
| 83 | * Check to see if the issue has already been raised.
|
| 84 | * [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.
|
| 85 | * 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.
|
| 86 |
|
| 87 | ### 📝 Pull Requests
|
| 88 |
|
| 89 | 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.
|
| 90 |
|
| 91 | ## Sponsors
|
| 92 |
|
| 93 | #### Cross-browser testing provided by [BrowserStack](https://www.browserstack.com)
|
| 94 | [](https://www.browserstack.com)
|
| 95 |
|
| 96 | #### IDE's provided by [JetBrains](https://www.jetbrains.com?from=Fomantic-UI)
|
| 97 | [](https://www.jetbrains.com?from=Fomantic-UI)
|
| 98 |
|
| 99 | ---
|
| 100 |
|
| 101 | #### Credit
|
| 102 | Semantic-UI was beautifully crafted by [@jlukic](https://github.com/jlukic)
|