1 | ![Fomantic Logo](https://fomantic-ui.com/images/logo.png#128)
|
2 |
|
3 | # Fomantic-UI
|
4 | A community fork of the popular Semantic-UI framework.
|
5 |
|
6 | [![GitHub Actions Status](https://github.com/fomantic/Fomantic-UI/workflows/CI/badge.svg)](https://github.com/fomantic/Fomantic-UI/actions)
|
7 | [![last commit (develop)](https://img.shields.io/github/last-commit/fomantic/Fomantic-UI/develop.svg?label=last%20commit%20%28develop%29)](https://github.com/fomantic/Fomantic-UI/commits/develop)
|
8 | [![License](https://img.shields.io/github/license/fomantic/Fomantic-UI?color=%233fb911)](https://github.com/fomantic/Fomantic-UI/blob/1fd94d2479f297c906bed557f0567d1d3f0a4d2c/LICENSE.md)
|
9 |
|
10 | [![Discord Server](https://img.shields.io/discord/453127116427493376.svg?label=Discord)](https://discord.gg/YChxjJ3)
|
11 | [![Follow on Twitter](https://img.shields.io/twitter/follow/fomanticui?style=social)](https://twitter.com/fomanticui)
|
12 |
|
13 | [![npm downloads](https://img.shields.io/npm/dm/fomantic-ui.svg?label=npm%20downloads)](https://www.npmjs.com/package/fomantic-ui)
|
14 | [![npm version](https://img.shields.io/npm/v/fomantic-ui)](https://www.npmjs.com/package/fomantic-ui)
|
15 |
|
16 | [![jsdelivr](https://data.jsdelivr.com/v1/package/npm/fomantic-ui/badge?style=rounded)](https://www.jsdelivr.com/package/npm/fomantic-ui)
|
17 | [![CDNJS](https://img.shields.io/cdnjs/v/fomantic-ui?color=e95420)](https://cdnjs.com/libraries/fomantic-ui)
|
18 |
|
19 | [![Package Quality](https://npm.packagequality.com/shield/fomantic-ui.svg?label=package%20quality)](https://packagequality.com/#?package=fomantic-ui)
|
20 | [![GitHub contributors](https://img.shields.io/github/contributors/fomantic/Fomantic-UI)](https://github.com/fomantic/Fomantic-UI/graphs/contributors)
|
21 | [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=fomantic/Fomantic-UI)](https://dependabot.com)
|
22 |
|
23 | ---
|
24 |
|
25 | > *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
|
26 | >
|
27 | > *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).
|
28 | >
|
29 | > 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
|
30 |
|
31 | ---
|
32 |
|
33 | 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.
|
34 |
|
35 | ## 📡 Installation
|
36 |
|
37 | ```bash
|
38 | $ npm install fomantic-ui --save
|
39 | ```
|
40 |
|
41 | Fomantic UI includes an interactive installer to help setup your project.
|
42 |
|
43 | * For more details on setup visit our [getting started guide](http://fomantic-ui.com/introduction/getting-started.html).
|
44 | * To learn more about theming please read our [theming guide](http://fomantic-ui.com/usage/theming.html)
|
45 |
|
46 | ### 💻 Browser Support
|
47 |
|
48 | * Last 2 Versions FF, Chrome, Safari Mac
|
49 | * IE 11+
|
50 | * Android 4.4+, Chrome for Android 44+
|
51 | * iOS Safari 7+
|
52 | * Microsoft Edge 12+
|
53 |
|
54 | 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.
|
55 |
|
56 | ---
|
57 |
|
58 | ## 📦 Other packages
|
59 |
|
60 | | Environment | Install Command | Repository | Third-Party |
|
61 | |-------------|---------------------------------------|------------------------------------------------------------------|-------------|
|
62 | | CSS Only | `npm install --save fomantic-ui-css` | [Fomantic-UI-CSS](https://github.com/fomantic/Fomantic-UI-CSS) | |
|
63 | | LESS | `npm install --save fomantic-ui-less` | [Fomantic-UI-LESS](https://github.com/fomantic/Fomantic-UI-LESS) | |
|
64 | | SASS | `gem 'fomantic-ui-sass'` | [Fomantic-UI-SASS](https://github.com/fomantic/Fomantic-UI-SASS) | ✅ |
|
65 |
|
66 | ---
|
67 |
|
68 | ## 💬 Community
|
69 |
|
70 | ### 💡 Getting Help
|
71 |
|
72 | If you have a usage question please **do not post** post it to GitHub Issues. You can ask for usage help via our [Discord](https://discord.gg/YChxjJ3) server.
|
73 | Please only create Github issues for bug's and feature requests or any other related issue.
|
74 |
|
75 | ### 🐛 Submitting Bugs and Enhancements
|
76 | [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:
|
77 | * Check to see if the issue has already been raised.
|
78 | * [Fork this boilerplate JSFiddle](https://jsfiddle.net/31d6y7mn) to create a test case for your bug. If a bug is apparent in the docs, that's ok as a test case, just make it clear exactly how to reproduce the issue. Only bugs that include a test case can be triaged.
|
79 | * 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.
|
80 |
|
81 | ### 📝 Pull Requests
|
82 |
|
83 | Before creating a pull request be sure to read the [contributing](CONTRIBUTING.md) guide, this is where we explain everything you need to know about contributing to Fomantic-UI.
|
84 |
|
85 | ## Sponsors
|
86 |
|
87 | #### Cross-browser testing provided by [BrowserStack](https://www.browserstack.com)
|
88 | [![BrowserStack](https://cdn.rawgit.com/fomantic/Fomantic-UI-Docs/35180e95/server/raw/images/browserstack.png)](https://www.browserstack.com)
|
89 |
|
90 | #### IDE's provided by [JetBrains](https://www.jetbrains.com?from=Fomantic-UI)
|
91 | [![JetBrains](https://fomantic-ui.com/images/jetbrains.svg)](https://www.jetbrains.com?from=Fomantic-UI)
|
92 |
|
93 | ---
|
94 |
|
95 | #### Credit
|
96 | Semantic-UI was beautifully crafted by [@jlukic](https://github.com/jlukic)
|