Download Semantic UI navigate to the install folder then run a gulp command.
To build all files:
gulp buildTo watch for changes
gulp watchSemantic UI uses Gulp for several reasons:
A Semantic UI project includes the following folder structure.
Below is a list of all available gulp commands
| Command | Description |
|---|---|
| install | Asks install questions to setup semantic.json |
| watch (default) | Watches for changes in source files, and builds file on change |
| build | Build all files |
| clean | Cleans dist/ folder |
| version | Outputs current version |
| build-javascript | Build JS files |
| build-css | Build CSS files |
| build-assets | Build assets files |
| serve-docs | Serves files to local docs instance |
| build-docs | Builds files to docs folder |
Build tool settings are stored in a special file called semantic.json It can be included in any folder that is in a parent folder of the semantic install folder.
If you used the npm or meteor, a semantic.json file is automatically generated for you in the root of your project. If you used a different package manager you can run gulp install to run the interactive installer.
{
// base path added to all other paths specified in "paths"
"base": "",
// current version of Semantic UI
"version": "2.4.2",
"paths": {
"source": {
// source theme.config
"config" : "src/theme.config",
// source definition folder
"definitions" : "src/definitions/",
// source site theme
"site" : "src/site/",
// source themes folder
"themes" : "src/themes/"
},
"output": {
// packaged source (both compressed/uncompressed)
"packaged" : "dist/",
// uncompressed source
"uncompressed" : "dist/components/",
// compressed source
"compressed" : "dist/components/",
// output directory for theme assets
"themes" : "dist/themes/"
},
// directory for gulp clean task
"clean" : "dist/"
},
// when set to an integer permission, will set dist files with this file permission
"permission" : false,
// whether gulp watch/build should run RTLCSS
"rtl": false,
// will only include components with these names
"components": [
"reset",
"site",
"button",
"container",
"divider",
"flag",
"header",
"icon",
"image",
"input",
"label",
"list",
"loader",
"rail",
"reveal",
"segment",
"step",
"breadcrumb",
"form",
"grid",
"menu",
"message",
"table",
"ad",
"card",
"comment",
"feed",
"item",
"statistic",
"accordion",
"checkbox",
"dimmer",
"dropdown",
"embed",
"modal",
"nag",
"popup",
"progress",
"rating",
"search",
"shape",
"sidebar",
"sticky",
"tab",
"transition",
"api",
"state",
"visibility"
],
// whether to include special project maintainer tasks
"admin": false
}LESS uses a special configuration file theme.config which lets you specify what theme each component should use. If you have not generated this file yet, you will receive an error message when running build tools
You can learn more about theme.config by checking out the theming guide
See our recipes section for examples on how to import individual gulp tasks into your custom Gulpfile.
We've added a new setting to semantic.json in 2.2 to help make working with a CLI, or other automated deployments more streamlined.
Specifying autoInstall: true in an environments semantic.json configuration will prevent any user prompting when running npm install allowing for automated deployment.
Support for the continued development of Semantic UI comes directly from the community.
This translation is only % complete!
We need your help to make Semantic available to people who speak your language.
Our translation tools are easy to use and allow you to translate text without having to leave the site.
Semantic is available at semantic-ui.cn a mirror site hosted inside China. This should make browsing much faster for those visiting from mainland China.