This folder contains the templates used to generate the static website for semantic-ui.com
How to Use
To install DocPad, the static site generator used to create the html for the site.
npm install -g docpad docpad install eco; docpad update; docpad upgrade;
Generating SUI for Docs
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
# assumes ./docs and ./ui for default paths, run from ./ui (the folder name ./ui may be any folder that contains the Semantic UI build files) # run gulp build-docs from the folder containing Semantic UI this will build docs into the sibling folder ./docs gulp build-docs
The default location for
build-docsis an adjacent folder with the name
docs/. 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:
#run from inside docs folder that will now contain the compiled docs - windows users can then navigate to http://localhost:9778 docpad run
To watch for changes from your ui folder to serve to your docs instance
Help Fix Typos and Errors
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.