This folder contains the templates used to generate the static website for semantic-ui.com.
This repo can be used to create a fork of the UI documents to serve as styleguide for your project.
You must install DocPad, the static site generator used to create the HTML for the site, to render the contents of this repository.
npm install -g docpad docpad install eco; docpad update; docpad upgrade;
Generating Semantic UI for Docs
Assuming two sibling folders:
- UI folder ./ui
- Docs folder ./docs
- Clone both repos to respective folders
- npm install in both directories
- Go through Semantic UI installer steps (auto)
gulp build-docs(builds files to ./docs)
- Go to http://localhost:9778/ docs should be there
- Optionally run
gulp serve-docsin ./ui to serve any changes from ./ui/src to ./docs
Running the Server
Start the docs server (and generate docs):
# run from inside docs folder that will now contain the compiled docs # windows users can then navigate to http://localhost:9778 docpad run
Watch for changes from your UI folder, and serve to the docs instance:
Publishing to GitHub Pages
You can publish your docs to GitHub Pages from the command line automatically
docpad deploy-ghpages --env static
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
- Click to submit a pull request