https://github.com/semantic-org/semantic-ui-1.0-docs
This repository hosts deployed files for 1.x Semantic UI Docs
https://github.com/semantic-org/semantic-ui-1.0-docs
Last synced: 9 months ago
JSON representation
This repository hosts deployed files for 1.x Semantic UI Docs
- Host: GitHub
- URL: https://github.com/semantic-org/semantic-ui-1.0-docs
- Owner: Semantic-Org
- Created: 2015-07-05T17:53:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-07-05T18:02:57.000Z (over 10 years ago)
- Last Synced: 2025-03-27T12:47:00.759Z (10 months ago)
- Language: JavaScript
- Homepage: http://semantic-org.github.io/Semantic-UI-1.0-Docs/
- Size: 69.1 MB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Semantic Docs
This folder contains the templates used to generate the static website for [semantic-ui.com](http://www.semantic-ui.com)
## How to Use
To install [DocPad](http://github.com/docpad/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-docs`` is 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](https://github.com/Semantic-Org/Semantic-UI/blob/master/tasks/admin/docs.json)
### Running Server
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
```
gulp serve-docs
```
## Help Fix Typos and Errors
If you find any typos or mistakes, submitting a fix is easy!
[Open the documents folder](https://github.com/Semantic-Org/Semantic-UI-Docs/tree/master/server/documents) on GitHub, click the edit button on the appropriate page. Then click to submit a pull request.