Skip to content

Commit 2e0bdc6

Browse files
committed
Merge branch 'master' of github.com:Semantic-Org/Semantic-UI-Docs into next
2 parents 67682d9 + 860a08e commit 2e0bdc6

8 files changed

Lines changed: 91 additions & 49 deletions

File tree

server/documents/hotfix.html.eco

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ type : 'Library'
1010
<!-- TEST JS HERE !-->
1111
<script>
1212
$(document).ready(function() {
13-
$('.button').popup({
14-
on: 'hover',
15-
onShow: function() {
16-
console.log('show');
17-
}
18-
});
1913
});
2014
</script>
2115

@@ -24,6 +18,6 @@ $(document).ready(function() {
2418
</style>
2519

2620
<div class="ui container" style="padding-top: 2em;">
27-
<div class="ui button first" data-content="One">One</div>
28-
<div class="ui button second" data-content="Two">Two</div>
21+
22+
</div>
2923
</body>

server/documents/introduction/advanced-usage.html.eco

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ type : 'Introduction'
1616
<div class="no example">
1717
<h4>Importing Gulp Tasks</h4>
1818
<p>You don't have to use <a href="/introduction/build-tools.html">our gulp pipeline</a>, just import the task into your own <code>gulpfile</code></p>
19+
<p>You can <a href="https://github.com/Semantic-Org/Example-External-Gulpfile" target="_blank">fork this example project</a> to see an example of how to import Semantic UI tasks into your project.</p>
1920
<div class="ignored code" data-type="JS" data-title="Custom gulpfile.js">
2021
var
2122
gulp = require('gulp'),
@@ -28,6 +29,13 @@ type : 'Introduction'
2829
</div>
2930
</div>
3031

32+
<h2 class="ui dividing header">Prototyping with Semantic UI</h2>
33+
<div class="no example">
34+
<h4>Sketch Files</h4>
35+
<p>If you are looking to prototype layouts using <a href="http://bohemiancoding.com/sketch/" target="_blank">Sketch</a> with Semantic UI check out <a href="https://github.com/guacamoly/semantic-ui-kit-for-sketch" target="_blank">Semantic UI Sketch Files</a></p>
36+
<img class="ui bordered rounded fluid image" src="https://github.com/guacamoly/semantic-ui-kit-for-sketch/raw/master/snapshot.jpg?raw=true">
37+
</div>
38+
3139
<h2 class="ui dividing header">Single Components</h2>
3240

3341
<div class="no example">

server/documents/introduction/build-tools.html.eco

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,4 +302,9 @@ type : 'Introduction'
302302
<p>You can learn more about <code>theme.config</code> by checking out the <a href="/usage/theming.html#using-packaged-themes">theming guide</a></p>
303303
</div>
304304

305+
<div class="no example">
306+
<h4>Importing Gulp Tasks</h4>
307+
<p>See our <a href="/introduction/advanced-usage.html">recipes section</a> for examples on how to import individual gulp tasks into your custom Gulpfile.</p>
308+
</div>
309+
305310
</div>

server/documents/introduction/getting-started.html.eco

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,24 @@ type : 'Main'
5656
</div>
5757
</div>
5858
<div class="ui basic tab vertical segment" data-tab="linux">
59-
<h4>Install from Git without Sudo</h4>
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>
6063
<div class="ignored code" data-type="bash">
61-
mkdir ~/local
62-
echo 'export PATH=$HOME/local/bin:$PATH' >> ~/.bashrc
63-
. ~/.bashrc
64-
git clone git://github.com/joyent/node.git
65-
cd node
66-
./configure --prefix=~/local
67-
make install
68-
git clone git://github.com/isaacs/npm.git
69-
cd npm
70-
make install
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
7177
</div>
7278
</div>
7379
<div class="ui basic tab vertical segment" data-tab="win">
@@ -76,9 +82,21 @@ type : 'Main'
7682
</div>
7783
</div>
7884

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+
7994
<div class="no example">
8095
<h4>Install Semantic UI</h4>
8196
<p>Semantic UI is available in an eponymous package on NPM</p>
97+
<div class="ui ignored warning message">
98+
If you experience issues with install hanging after setup, hold tight <a href="https://github.com/Semantic-Org/Semantic-UI/issues/2086#issuecomment-123771843">a fix is on the way</a> shortly
99+
</div>
82100
<div class="ui secondary menu">
83101
<a class="active item" data-tab="video">
84102
Video

server/documents/introduction/glossary.html.eco

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,32 @@ type : 'Introduction'
1616

1717
<div class="no example">
1818
<h4>Types of Components</h4>
19-
<p>The following table helps differentiate between different types of components in Semantic UI's documentation</p>
19+
<p>Semantic UI classifies components into different definition types depending on its qualities. Each of these five types uses a unique definition format.</p>
2020
<table class="ui large very padded definition table">
2121
<tbody>
2222
<tr>
2323
<td class="three wide">Globals</td>
2424
<td>
2525
Globals are styles that are applied across a site. These include things like css resets, and sitewide font, link and sizing defaults.</p>
26-
<p>Most importantly, globals include site-wide theming variables that other components can inherit and modify.</td>
26+
<p>Most importantly, globals include site-wide <a href="/usage/theming.html">theming variables</a> that other components can inherit and modify.</td>
2727
</tr>
2828
</tr>
2929
<tr>
3030
<td>Element</td>
3131
<td>
32-
UI elements are page elements with a single function. They can exist alone or in a plural form with elements sharing qualities.</td>
32+
UI elements are page elements with a single function. They can exist alone or in a plural form with elements sharing qualities.</p>
33+
<p>For example, a group of <a href="/elements/button.html">buttons</a> may use <code>ui red buttons</code> as a grouping with individual <code>ui button</code> children.</td>
3334
</tr>
3435
<tr>
3536
<td>Collection</td>
3637
<td>
37-
<p>Collections are heterogenous groups of components which are usually found together. They describe a list of "usual suspects" which appear in a certain context. They may include and extend other ui elements for use in certain contexts—for example form may extend ui dropdown or input—as well as include their own content.</p>
38+
<p>Collections are heterogenous groups of components which are usually found together. They describe a list of "usual suspects" which appear in a certain context. They may include and extend other ui elements for use in certain contexts—for example <a href="/collections/form.html">form</a> may extend <a href="/modules/dropdown.html">dropdown</a> or <a href="/elements/input.html">input</a>—as well as include their own content.</p>
3839
</td>
3940
</tr>
4041
<tr>
4142
<td>Views</td>
4243
<td>
43-
<p>A view is a convention for presenting specific types of content that is usually consistent across a website. These include things like comments, user activity feeds, or cards.</p>
44+
<p>A view is a convention for presenting specific types of content that is usually consistent across a website. These include things like <a href="/views/comment.html">comments</a>, <a href="/views/feed.html">activity feeds</a>, or <a href="/views/card.html">cards</a>.</p>
4445
</td>
4546
</tr>
4647
<tr>
@@ -59,9 +60,41 @@ type : 'Introduction'
5960
</table>
6061
</div>
6162

63+
<div class="no example">
64+
<h4>Project Terminology</h4>
65+
<p>Semantic UI classifies components into separate definition groupings.<p>
66+
67+
<table class="ui large very padded definition table">
68+
<tbody>
69+
<tr>
70+
<td class="three wide">Component</td>
71+
<td>
72+
A component is a general term used to refer to any user interface element packaged for distribution.
73+
</td>
74+
</tr>
75+
<tr>
76+
<td>Definition</td>
77+
<td>
78+
<p>A definition is a set of css and javascript which describe a component's essential qualities.</p>
79+
<p>Definition use variables to express arbitrary parts of a component's appearance so that they can be changed with themes.</p>
80+
</td>
81+
</tr>
82+
<tr>
83+
<td>ui</td>
84+
<td>
85+
<p><code>ui</code> is a special class name used to distinguish parts of components from components.</p>
86+
<p>For example, a <a href="/elements/list.html">list</a> will receive the class <code>ui list</code> because it has a corresponding definition, however a list item, will receive just the class <code>item</code>.</p>
87+
<p>The ui class name helps encapsulate css rules by making sure all 'parts of a component' are defined in context to a 'whole' component.</p>
88+
<p>It also helps make scanning unknown code simpler. If you see <code>ui</code> you know you are looking at a component.</p>
89+
</td>
90+
</tr>
91+
</tbody>
92+
</table>
93+
</div>
94+
6295
<div class="no example">
6396
<h4>Definition Terminology</h4>
64-
<p>When browsing Semantic UI definitions, you will see content grouped into different sections. These are parts of a definition which generally remain consistent between components<p>
97+
<p>When browsing Semantic UI definitions, you will see content grouped into different sections. These parts of a definition are consistent across definitions, and are common patterns for describing components.<p>
6598

6699
<table class="ui large very padded definition table">
67100
<tbody>

server/documents/modules/dropdown.html.eco

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1361,6 +1361,7 @@ themes : ['Default', 'Material']
13611361
<div class="evaluated code" data-type="javascript">
13621362
$('.no.label.example .ui.dropdown')
13631363
.dropdown({
1364+
debug: true,
13641365
useLabels: false
13651366
})
13661367
;
@@ -1403,7 +1404,7 @@ themes : ['Default', 'Material']
14031404
</div>
14041405
</div>
14051406

1406-
<div class="restore example">
1407+
<div class="restore dropdown example">
14071408
<h4 class="ui header">Restoring Defaults</h4>
14081409
<p>You can restore a dropdown to its value set on page load</p>
14091410
<div class="ui multiple selection dropdown">

server/documents/modules/modal.html.eco

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ themes : ['Default', 'Material']
246246
<div class="header">
247247
Profile Picture
248248
</div>
249-
<div class="content">
249+
<div class="image content">
250250
<div class="ui medium image">
251251
<img src="/images/avatar/large/chris.jpg">
252252
</div>

server/documents/modules/tab.html.eco

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -364,35 +364,18 @@ themes : ['Default']
364364
<h4>Using HTML5 State</h4>
365365
<p>For sites that are able to replicate change on the server, tab can automatically map changes in tab navigation to <a href="http://diveintohtml5.info/history.html" target="_blank">html5 state.</a>
366366
</p>
367-
<div class="ui ignored info message">
368-
Since these docs are statically hosted on GitHub Pages, html state is not supported. The following example will cause a "not found" error on page refresh.
367+
<div class="ui ignored warning message">
368+
Since these docs are statically hosted on GitHub Pages, html5 state tabs are not demonstratable from the docs. You will need to try this example in your own code.
369369
</div>
370-
<div class="evaluated code" data-type="javascript">
371-
$('.state.example .menu .item')
370+
<div class="code" data-type="javascript">
371+
$('.ui.menu .item')
372372
.tab({
373-
context : '.state.example',
374-
history : true,
375373
historyType : 'state',
376374
// base url for all other path changes
377-
path : '/modules/tab.html'
375+
path : '/my/base/url'
378376
})
379377
;
380378
</div>
381-
382-
<div class="ui pointing secondary menu">
383-
<a class="active item" data-tab="olive">Olive</a>
384-
<a class="item" data-tab="apple">Apple</a>
385-
<a class="item" data-tab="cucumber">Cucumber</a>
386-
</div>
387-
<div class="ui active tab segment" data-tab="olive">
388-
Olive tab
389-
</div>
390-
<div class="ui tab segment" data-tab="apple">
391-
Apple tab
392-
</div>
393-
<div class="ui tab segment" data-tab="cucumber">
394-
Cucumber tab
395-
</div>
396379
</div>
397380

398381
</div>

0 commit comments

Comments
 (0)