|
| 1 | +--- |
| 2 | +layout : 'default' |
| 3 | +css : 'started' |
| 4 | +standalone : true |
| 5 | +order : 1 |
| 6 | + |
| 7 | +title : 'Getting Started' |
| 8 | +description : 'Getting up and running with Semantic UI' |
| 9 | +type : 'Main' |
| 10 | +--- |
| 11 | +<script src="/javascript/started.js"></script> |
| 12 | + |
| 13 | +<%- @partial('header') %> |
| 14 | + |
| 15 | +<div class="main ui intro container"> |
| 16 | + |
| 17 | + <h2 class="ui dividing header">Preface</h2> |
| 18 | + |
| 19 | + <div class="no example"> |
| 20 | + |
| 21 | + <h4 class="ui header">Using Build Tools</h4> |
| 22 | + |
| 23 | + <p>Semantic UI packaged Gulp build tools so your project can preserve its <a href="/usage/theming.html">own theme changes</a>.</p> |
| 24 | + <p>The easiest way to install Semantic UI is our NPM package which contains special install scripts to make setup interactive and updates seamless.</p> |
| 25 | + |
| 26 | + <p>For installing with specific integrations like, Ember, React, or Meteor, see our <a href="/introduction/integrations.html">integration guide</a></p> |
| 27 | + <p>For integrating Semantic UI tasks into your own build tools, or using a CDN see our <a href="/introduction/advanced-usage.html">recipes</a> section.</p> |
| 28 | + |
| 29 | + </div> |
| 30 | + |
| 31 | + <h2 class="ui dividing header">Installing</h2> |
| 32 | + |
| 33 | + |
| 34 | + <div class="no example"> |
| 35 | + <h4 class="ui header">Install NodeJS</h4> |
| 36 | + <p>If you are unfamiliar with setting up NodeJS you can follow the steps below, or check out the <a href="https://nodejs.org/download/" target="_blank">download page</a> on <a href="http://www.nodejs.org" target="_blank">nodejs.org</a></p> |
| 37 | + |
| 38 | + <div class="ui secondary menu"> |
| 39 | + <a data-tab="mac" class="active item">Mac</a> |
| 40 | + <a data-tab="linux" class="item">Linux</a> |
| 41 | + <a data-tab="win" class="item">Windows</a> |
| 42 | + </div> |
| 43 | + <div class="ui active basic tab vertical segment" data-tab="mac"> |
| 44 | + <h4>Option 1: Homebrew</h4> |
| 45 | + <p>After installing <a href="http://brew.sh/" target="_blank">homebrew</a></p> |
| 46 | + <div class="ignored code" data-type="bash"> |
| 47 | + brew install node |
| 48 | + </div> |
| 49 | + <h4>Option 2: Git</h4> |
| 50 | + <div class="ignored code" data-type="bash"> |
| 51 | + git clone git://github.com/ry/node.git |
| 52 | + cd node |
| 53 | + ./configure |
| 54 | + make |
| 55 | + sudo make install |
| 56 | + </div> |
| 57 | + </div> |
| 58 | + <div class="ui basic tab vertical segment" data-tab="linux"> |
| 59 | + <h4>Install via PPA</h4> |
| 60 | + <p>Although <a href="http://www.ubuntuupdates.org/ppa/chris_lea_nodejs" target="_blank">Chris Lea's PPA</a> was once the best way to install node, it is now somewhat out of date.</p> |
| 61 | + <p>The recommended path to install Semantic UI is using <a href="https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager" target="_blank">Joyent's package manager</a> guide.</p> |
| 62 | + <h4>Ubuntu</h4> |
| 63 | + <div class="ignored code" data-type="bash"> |
| 64 | + curl --silent --location https://deb.nodesource.com/setup_0.12 | sudo bash - |
| 65 | + sudo apt-get install --yes nodejs |
| 66 | + </div> |
| 67 | + <h4>Debian</h4> |
| 68 | + <div class="ignored code" data-type="bash"> |
| 69 | + apt-get install curl |
| 70 | + curl --silent --location https://deb.nodesource.com/setup_0.12 | bash - |
| 71 | + apt-get install --yes nodejs |
| 72 | + </div> |
| 73 | + <h4>Red Hat</h4> |
| 74 | + <div class="ignored code" data-type="bash"> |
| 75 | + curl --silent --location https://rpm.nodesource.com/setup | bash - |
| 76 | + yum -y install nodejs |
| 77 | + </div> |
| 78 | + </div> |
| 79 | + <div class="ui basic tab vertical segment" data-tab="win"> |
| 80 | + <h4>Install the exe</h4> |
| 81 | + <p>Download the <a href="http://nodejs.org/download/">NodeJS executable</a>.</p> |
| 82 | + </div> |
| 83 | + </div> |
| 84 | + |
| 85 | + <div class="no example"> |
| 86 | + <h4>Install Gulp</h4> |
| 87 | + <p>Semantic UI uses <a href="http://www.gulpjs.com" target="_blank">Gulp</a> to provide command line tools for building themed versions of the library with just the components you need.</p> |
| 88 | + <p>Gulp is an NPM module and must be installed globally</p> |
| 89 | + <div class="ignored code" data-type="bash"> |
| 90 | + npm install -g gulp |
| 91 | + </div> |
| 92 | + </div> |
| 93 | + |
| 94 | + <div class="no example"> |
| 95 | + <h4>Install Semantic UI</h4> |
| 96 | + <p>Semantic UI is available in an eponymous package on NPM</p> |
| 97 | + <div class="ui secondary menu"> |
| 98 | + <a class="active item" data-tab="video"> |
| 99 | + Video |
| 100 | + </a> |
| 101 | + <a class="item" data-tab="code"> |
| 102 | + Code |
| 103 | + </a> |
| 104 | + </div> |
| 105 | + <div class="ui active tab" data-tab="video"> |
| 106 | + <script type="text/javascript" src="https://asciinema.org/a/22121.js" id="asciicast-22121" async></script> |
| 107 | + </div> |
| 108 | + <div class="ui tab" data-tab="code"> |
| 109 | + <div class="ignored code" data-type="bash"> |
| 110 | + npm install semantic-ui --save |
| 111 | + cd semantic/ |
| 112 | + gulp build |
| 113 | + </div> |
| 114 | + </div> |
| 115 | + </div> |
| 116 | + |
| 117 | + <div class="no example"> |
| 118 | + <h4>Include in Your HTML</h4> |
| 119 | + <p>Running the gulp build tools will compile css and javascript for use in your project. Just link to these files in your html.</p> |
| 120 | + <div class="ignored code" data-type="html" data-escape="true"> |
| 121 | + <link rel="stylesheet" type="text/css" href="semantic/dist/semantic.min.css"> |
| 122 | + <script src="semantic/dist/semantic.min.js"></script> |
| 123 | + </div> |
| 124 | + </div> |
| 125 | + <h2 class="ui dividing header">Updating</h2> |
| 126 | + |
| 127 | + <div class="no example"> |
| 128 | + <h4>Updating via NPM</h4> |
| 129 | + <p>Semantic's NPM install script will automatically update Semantic UI to the latest version while preserving your site and packaged themes.</p> |
| 130 | + <div class="ignored code" data-type="bash"> |
| 131 | + npm update |
| 132 | + </div> |
| 133 | + </div> |
| 134 | + |
| 135 | + <h2 class="ui dividing header">Next Steps</h2> |
| 136 | + |
| 137 | + <div class="no example"> |
| 138 | + <h4>All Set!</h4> |
| 139 | + <p>Well done! Semantic UI is now ready to be used.</p> |
| 140 | + |
| 141 | + <div class="three column divided stackable center aligned ui grid"> |
| 142 | + <div class="column"> |
| 143 | + <div class="ui icon header"> |
| 144 | + <i class="rocket circular icon"></i> |
| 145 | + See how to use <a href="/introduction/build-tools.html">gulp commands</a> and build tools |
| 146 | + </div> |
| 147 | + </div> |
| 148 | + <div class="column"> |
| 149 | + <div class="ui icon header"> |
| 150 | + <i class="theme circular icon"></i> |
| 151 | + Learn about <a href="/usage/theming.html">changing themes</a> |
| 152 | + </div> |
| 153 | + </div> |
| 154 | + <div class="column"> |
| 155 | + <div class="ui icon header"> |
| 156 | + <i class="food circular icon"></i> |
| 157 | + See <a href="/introduction/advanced-usage.html">recipes</a> for using Semantic UI in your project |
| 158 | + </div> |
| 159 | + </div> |
| 160 | + </div> |
| 161 | + </div> |
| 162 | + |
| 163 | +</div> |
0 commit comments