https://github.com/indico/indico-styleguide
Styleguide of the Indico project
https://github.com/indico/indico-styleguide
css styleguide ui
Last synced: about 1 month ago
JSON representation
Styleguide of the Indico project
- Host: GitHub
- URL: https://github.com/indico/indico-styleguide
- Owner: indico
- Created: 2017-04-07T11:37:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-26T14:27:36.000Z (almost 9 years ago)
- Last Synced: 2025-07-13T16:44:26.292Z (11 months ago)
- Topics: css, styleguide, ui
- Language: HTML
- Size: 5.21 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Indico Styleguide
This is the styleguide of the [Indico project](https://github.com/indico/indico). Here you'll find useful components to help you develop Indico's UI solutions. This guide contains real working examples, code snippets, documentation, and style guidelines. The styleguide is build on top of [Fabricator](https://github.com/fbrctr/fabricator).
## Installing styleguide
Clone repo:
```
git clone --recursive git@github.com:indico/indico-styleguide.git
```
With the indico virtualenv active, initialize Indico’s submodules:
```
cd indico-styleguide/indico
fab setup_deps
```
From the project’s root directory, start the server:
```
npm start
```
## Updating styleguide
Commit the changes in the master branch:
```
git add src/materials/components/buttons/10-button.html
git commit -m “Add i-button documentation”
git push upstream master
```
Generate output code and deploy on gh-pages:
```
gulp default # Generates output code
gulp deploy # Pushes code to the gh-pages branch
```
## Fetching Indico style changes
Since Indico is a submodule of the styleguide project, the only necessary thing to do in order to fetch the latest Indico code is to update the submodule:
```
cd indico
git pull
cd ..
git add indico
git commit -m “Update Indico submodule”
```
## Resources
* http://fbrctr.github.io (Fabricator documentation)
* https://goo.gl/aBPTt7 (Deploying To Github Pages With Gulp)
* https://goo.gl/FLwmBz (Indico presentation)