From 1cd3ac269e8b004b77807c6569b4c56d1c8a3cc0 Mon Sep 17 00:00:00 2001 From: jlukic Date: Thu, 19 Sep 2013 17:53:26 -0400 Subject: [PATCH] Adds build docs --- node/src/documents/project/build.html | 89 ++++++++++++++++++++ node/src/documents/project/contributing.html | 13 ++- 2 files changed, 95 insertions(+), 7 deletions(-) create mode 100755 node/src/documents/project/build.html diff --git a/node/src/documents/project/build.html b/node/src/documents/project/build.html new file mode 100755 index 000000000..b65d052b1 --- /dev/null +++ b/node/src/documents/project/build.html @@ -0,0 +1,89 @@ + --- +layout : 'default' +css : 'build' + +title : 'Building Semantic' +type : 'Semantic Project' +--- + +
+
+

Contributing +
Draft
+

+
+
+
+
+
+ Running Locally + Building packages +
+
+ +

Running Semantic Locally

+ +

It may be useful to run the development docs locally when working on a forked version of semantic, as the docs themselves help in testing out changes to ui components.

+ +

1) Install Node

+

Semantic docs are written in DocPad which requires NodeJS.

+ +
Make sure npm does not require sudo to operate, this might cause permissions issues.
+ + + +

2) Install Dependencies

+ +
+ npm install -g docpad +
+ +
+ npm install -g grunt-cli +
+ +

3) Fork Semantic

+ + + +

4) Start Your Server

+ +

It's important to note that all development code exists inside of /node inside the project. So all commands should be run relative to that directory.

+ +
+ cd node + docpad run +
+ +

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

+ + +

Fixing An Element

+ +

If you are working on fixing a UI element 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

+ +
+ grunt +
+ +

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

+ +

Packaging Elements

+

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

+ +
+ grunt build +
+ +
+ + Next: Library Introduction + + +
\ No newline at end of file diff --git a/node/src/documents/project/contributing.html b/node/src/documents/project/contributing.html index 6cac592d0..177d78e02 100755 --- a/node/src/documents/project/contributing.html +++ b/node/src/documents/project/contributing.html @@ -9,7 +9,6 @@ type : 'Semantic Project'

Contributing -
Draft

@@ -31,7 +30,7 @@ type : 'Semantic Project'

Publicity

- + @@ -46,14 +45,14 @@ type : 'Semantic Project' +

Ways to Contribute

+

Style Guide

Contributors should read over the coding guidelines for the project. Most importantly, the guide for language, as it is one of the most important parts about Semantic UI.

Language CSS Javascript -

Ways to Contribute

-

Bugs & Issues

Please submit any bugs you encounter when using the library to our Github Issues Tracker.

@@ -68,7 +67,7 @@ type : 'Semantic Project'

Semantic is looking for people to help contribute new UI components, and suggest extensions for our core library

-

If you have any suggestions for components missing from Semantic which you'd like to see in future versions please add suggestions to our public UI board. The current list of upcoming components, and there current development status can be seen on the contributor UI board.

+

If you have suggestions for components missing from Semantic which you'd like to see in future versions please add them to our public UI Component board. The current list of upcoming components, and their current development status can be seen on the contributor UI board.

Visit UI Development Boards

@@ -79,7 +78,7 @@ type : 'Semantic Project'

Community Development

-

We're looking currently for ideas on the best way to expand Semantic to include both core library and third party components. This requires creating a component specification which can be used by anyone to create ui components, and a package management system (website or command line) for distributing them.

+

We're looking currently for ideas on the best way to expand Semantic to include both core library and third party components. This requires creating a component specification which can be used by anyone to create ui components, and a package management system (website or command line) for authors to distribute them.

These features are very important for the healthy growth of the Semantic ecosystem, and to expand the number of components available to users.

@@ -91,7 +90,7 @@ type : 'Semantic Project'
- Next: Roadmap + Next: Building Semantic
\ No newline at end of file