Name: Semantic-UI-1.0-Docs
Owner: Semantic Org
Description: This repository hosts deployed files for 1.x Semantic UI Docs
Created: 2015-07-05 17:53:28.0
Updated: 2017-07-06 04:15:37.0
Pushed: 2015-07-05 18:02:57.0
Homepage: http://semantic-org.github.io/Semantic-UI-1.0-Docs/
Size: 72476
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 server you will need to build your UI files for the docs. Semantic UI includes a special command to build files for a docs instance that must be run from an adjacent Semantic UI folder. for example with a directory vendor -> SemanticUI place docs folder inside vendor to reflect vendor -> SemanticUI | docs
sumes ./docs and ./ui for default paths, run from ./ui (the folder name ./ui may be any folder that contains the Semantic UI build files)
n gulp build-docs from the folder containing Semantic UI this will build docs into the sibling folder ./docs
build-docs
The default location for
build-docsis an adjacent folder with the namedocs/. The command must be run from your UI folder and not from the docs folder.
To configure a different docs location modify tasks/docs.json
You can then start your docs server (and generate docs) using:
from inside docs folder that will now contain the compiled docs - windows users can then navigate to http://localhost:9778
ad run
To watch for changes from your ui folder to serve to your docs instance
serve-docs
If you find any typos or mistakes, submitting a fix is easy!
Open the documents folder on GitHub, click the edit button on the appropriate page. Then click to submit a pull request.