https://github.com/semantic-org/learn-semantic
Official repo of learnsemantic.com
https://github.com/semantic-org/learn-semantic
Last synced: 9 months ago
JSON representation
Official repo of learnsemantic.com
- Host: GitHub
- URL: https://github.com/semantic-org/learn-semantic
- Owner: Semantic-Org
- License: mit
- Created: 2013-10-28T17:04:10.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2015-03-05T22:04:26.000Z (almost 11 years ago)
- Last Synced: 2025-03-27T12:47:00.776Z (10 months ago)
- Language: JavaScript
- Homepage: http://www.learnsemantic.com
- Size: 41.5 MB
- Stars: 24
- Watchers: 9
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Semantic Docs
This folder contains the templates used to generate the static website for [learnsemantic.com](http://www.learnsemantic.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.
```
# assumes ./docs and ./ui for default paths, run from ./ui
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:
```
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/Learn-Semantic/tree/master/server/documents) on GitHub, click the edit button on the appropriate page. Then click to submit a pull request.