https://github.com/Semantic-Org/Semantic-UI-Docs

Official Documentation for Semantic UI
https://github.com/Semantic-Org/Semantic-UI-Docs

Last synced: 2 months ago
JSON representation

Official Documentation for Semantic UI

• Host: GitHub
• URL: https://github.com/Semantic-Org/Semantic-UI-Docs
• Owner: Semantic-Org
• Created: 2014-03-14T22:44:20.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T10:33:29.000Z (almost 2 years ago)
• Last Synced: 2024-07-31T07:18:24.739Z (5 months ago)
• Language: JavaScript
• Homepage: http://www.semantic-ui.com
• Size: 76 MB
• Stars: 303
• Watchers: 25
• Forks: 1,429
• Open Issues: 112
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - Semantic-UI-Docs - Official Documentation for Semantic UI (JavaScript)

README

        
# Semantic Docs

This folder contains the templates used to generate the static website for [semantic-ui.com](http://www.semantic-ui.com). 

This repo can be used to create a fork of the UI documents to serve as styleguide for your project.

### Installing Dependencies

You must install [DocPad](http://github.com/docpad/docpad), the static site generator used to create the HTML for the site, to render the contents of this repository.

SUI docs use a version of **DocPad compatible with Node 10**. It is recommended you install [NVM](https://github.com/nvm-sh/nvm) and a compatible node version in order to create the documentation.

```

nvm install 8

nvm use 8

```

To run docpad after cloning this repo

```

npm install -g [email protected]

docpad install;

```

Then finally to start the server

```

docpad run

```

### Generating Semantic UI for Docs

Assuming two sibling folders:

1. UI folder ./ui

2. Docs folder ./docs

* Clone both repos to respective folders

* npm install in both directories

* Go through Semantic UI installer steps (auto)

* In `./ui` folder `gulp build-docs` (builds files to ./docs)

* In `./docs` folder `docpad install` then `docpad run`

* Go to http://localhost:9778/ docs should be there

* Optionally run `gulp serve-docs` in ./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:

```

gulp serve-docs

```

### 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](https://github.com/Semantic-Org/Semantic-UI-Docs/tree/master/server/documents) on GitHub

- Click the “Edit” button on the appropriate page

- Click to submit a pull request