From ea2adf9e78a43d38356301520cb2925adf1aecbc Mon Sep 17 00:00:00 2001 From: jlukic Date: Fri, 27 Dec 2013 10:12:39 -0500 Subject: [PATCH] Accordion docs had extra closing tag, adds progress docs for warning, updates details of development docs --- server/documents/elements/progress.html.eco | 8 +++++++ server/documents/modules/accordion.html.eco | 1 - server/documents/modules/modal.html.eco | 2 +- server/documents/project/development.html.eco | 23 +++++++++++++++---- 4 files changed, 27 insertions(+), 7 deletions(-) diff --git a/server/documents/elements/progress.html.eco b/server/documents/elements/progress.html.eco index 075d42bab..9ef058818 100755 --- a/server/documents/elements/progress.html.eco +++ b/server/documents/elements/progress.html.eco @@ -46,6 +46,14 @@ type : 'UI Element' +
+

Warning

+

A progress bar can show a warning state

+
+
+
+
+

Failed

A progress bar can show failure

diff --git a/server/documents/modules/accordion.html.eco b/server/documents/modules/accordion.html.eco index fb07c5ca0..cbf6dd87c 100755 --- a/server/documents/modules/accordion.html.eco +++ b/server/documents/modules/accordion.html.eco @@ -208,7 +208,6 @@ type : 'UI Module' Level 2C Contents
- diff --git a/server/documents/modules/modal.html.eco b/server/documents/modules/modal.html.eco index a28d77b4b..fa1ca6259 100755 --- a/server/documents/modules/modal.html.eco +++ b/server/documents/modules/modal.html.eco @@ -202,8 +202,8 @@ type : 'UI Module'

A modal can use any named ui transition.

-
Choose transition
+
Horizontal Flip
Vertical Flip
diff --git a/server/documents/project/development.html.eco b/server/documents/project/development.html.eco index 118ca114f..bd9be57a3 100755 --- a/server/documents/project/development.html.eco +++ b/server/documents/project/development.html.eco @@ -26,6 +26,8 @@ type : 'Semantic Project'
Make sure npm does not require sudo to operate, this might cause permissions issues.
+

There are many tutorials online on how to install node in your environment, here are a few we think are helpful:

+
  • Node JS via Package Manager
  • Installing Node JS without sudo
    • @@ -35,9 +37,14 @@ type : 'Semantic Project' +

    Fork the Semantic repo into a directory on your local machine and navigate into that directory

    + +

    Alternatively, you can download the entire repository as a zip instead of using Git

    3. Install Dependencies

    -

    Running update inside the local directory will grab all packages in package.json in the root of the project.

    +

    NPM (Node Package Manager) keeps track of all the dependencies required for the project.

    + +

    Running npm update inside the local directory will grab all development dependencies from package.json and store them in the root of the project.

    npm update @@ -46,11 +53,15 @@ type : 'Semantic Project'

    4. Start Your Server

    +

    Now that you've installed all the dependencies, starting your server should be a simple command

    +
    docpad run
    -

    Docpad should now run an instance of semantic-ui.com locally you can access at http://localhost:9778

    +

    Docpad should now run the documentation on a local server accessible at http://localhost:9778

    + +

    A static version of the documentation will be generated every time you make a change to a document. This will also be available in the docs/ folder.

    5. (Optional) Install Karma

    @@ -61,19 +72,21 @@ type : 'Semantic Project' npm install -g karma
    +

    Installing Karma will allow you to run the unit tests on Javascript to ensure all tests are passed when changes are made to javascript code. This will also occur automatically when you create a pull request

    +

    Using Grunt

    Watch Changes in Source

    If you are working on fixing a UI component that is part of Semantic, your best bet is to work actively on the file in /src/{type}/{elementname}/ while running a watch script from grunt. This will rebuild the docs after you make changes, so you can see if you have corrected the issue you are fixing.

    -

    To see exactly what this is doing you can check out our commented gruntfile

    +

    To see exactly what this grunt tasks is doing view our commented gruntfile

    grunt
    -

    The watch task is the default grunt task for Semantic, so you can start it quite simply.

    +

    The watch task is the default grunt task for Semantic, so you can start it quite simply. This will copy files automatically from the src directory, compiling LESS files, whenever any changes are made.

    Run Unit Tests

    Tests will automatically run with grunt watch if you have started karma

    @@ -93,7 +106,7 @@ type : 'Semantic Project'

Build Semantic Packages Locally

-

For convenience there is also a separate grunt command for building minified, packaged, and compressed versions of the library.

+

There is also a separate grunt command for building minified, packaged, and compressed versions of the library. This might be useful when creating custom builds of Semantic.

grunt build