Name: Semantic-UI-Docs
Owner: Semantic Org
Description: Official Documentation for Semantic UI
Created: 2014-03-14 22:44:20.0
Updated: 2018-01-07 10:44:54.0
Pushed: 2018-01-11 16:08:58.0
Homepage: http://www.semantic-ui.com
Size: 78674
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This folder contains the templates used to generate the static website for semantic-ui.com
To install DocPad, the static site generator used to create the HTML for the site.
install -g docpad
ad install eco;
ad update; docpad upgrade;
Before running the server, you will need to build your UI files for the docs.
First, be sure your docs are in the right location.
For example, if your Semantic UI folder is under vendor/
, like this…
vendor/
SemanticUI/
...
...
Then you should put docs/
under vendor/
, so it looks like this:
vendor/
docs/
SemanticUI/
...
...
If you haven't run npm install
in your ./SemanticUI
folder yet, do that now. Next, run the commands to build the docs:
i" can be any folder that contains the SUI build files
/ui
build-docs
By default, docs build to build-docs/
(from the adjacent folder docs/
).
The command must be run from your UI folder! (In the above example, we use ./ui
.)
To configure a different docs
location, modify tasks/config/docs.js
accordingly.
Start the docs server (and generate docs):
n from inside docs folder that will now contain the compiled docs
ndows users can then navigate to http://localhost:9778
ad run
Watch for changes from your UI folder, and serve to the docs instance:
serve-docs
If you find any typos or mistakes, submitting a fix is easy!
documents/
folder on GitHub