You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 20, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+28-13Lines changed: 28 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,9 @@ The Confederation Web Guidelines are aimed at both internal Federal project mana
14
14
The design specifications described for use on the Internet or in intranets can also be used for other digital channels, such as for the creation of apps.
15
15
16
16
17
-
The latest release of the styleguide is available here: http://adminch.antistatique.net
17
+
The latest release of the styleguide is available here: http://swiss.github.io/styleguide/
18
18
19
-
If you want to collaborate or review the next release, go to the gh-pages here: http://antistatique.github.io/Swiss-Admin-web-guidelines
19
+
If you want to collaborate on the repo, go to this URL: https://github.com/swiss/styleguide
20
20
21
21
22
22
## The Swiss Federal Administration on the Internet
@@ -25,21 +25,20 @@ If you want to collaborate or review the next release, go to the gh-pages here:
25
25
26
26
The styleguide is located in the `/styleguide` directory. You can open `/styleguide/index.html` directly in your browser. (If you can't find it, you have to build all the assets).
27
27
28
-
#### How to use it in your project
28
+
#### Installation
29
29
30
30
There are several ways to get started:
31
31
32
+
-**Install with bower `bower install swiss-styleguide`**
32
33
- Use the provided build. Download the [latest release](https://github.com/antistatique/Swiss-Admin-web-guidelines/releases/latest) and include all the built assets in your project.
33
-
- Use the Github Pages generated styleguide only. Just download the [gh-pages branch](https://github.com/antistatique/Swiss-Admin-web-guidelines/archive/gh-pages.zip).
34
34
- Clone the repo `git clone https://github.com/antistatique/Swiss-Admin-web-guidelines.git`
35
-
- Install with bower `bower install Swiss-Admin-web-guidelines`
36
35
37
36
38
-
#### Installation (development tools)
37
+
##Contribution (development tools)
39
38
This is not needed to use the styleguide, only if you want to modify it to fix some bugs and contribute.
40
39
41
40
42
-
####Installation on OSX/Unix
41
+
### Installation on OSX/Unix
43
42
44
43
> We use [Gulp.js](http://gulpjs.com) to run tasks and build our styleguide with [Hologram](https://github.com/trulia/hologram).
45
44
@@ -62,9 +61,9 @@ $ bundle
62
61
63
62
[Browser-sync](http://www.browsersync.io) is automatically set up and will allow you to make changes and see them in real time.
64
63
65
-
####Installation on Windows
64
+
### Installation on Windows
66
65
67
-
This is the not the recommended OS. If you have a choice, use OSX.
66
+
This is the not the recommended OS. If you have a choice, use OS X. We are therefore not perfectly sure of the process below, please report or make a PR to make this better.
68
67
69
68
*Warning: This was tested on the [Windows PowerShell](http://en.wikipedia.org/wiki/Windows_PowerShell) but should work on any shell that support UTF8.*
70
69
@@ -78,7 +77,7 @@ This is the not the recommended OS. If you have a choice, use OSX.
78
77
79
78
- Download and install [Node.js](http://nodejs.org)
80
79
81
-
- Install [Git for Windows](http://msysgit.github.io/) (recommended) or alternatively [Github for Windows](https://windows.github.com)`
80
+
- Install [Git for Windows](http://msysgit.github.io/) (recommended) or alternatively [Github for Windows](https://windows.github.com)
The theme has his own gulpfile (for the moment). So you have to do the following command to build the assets to then generate the styleguide with `$ hologram`:
147
+
The theme has his own gulpfile (for the moment). So you have to do the following command to build the assets then generate the styleguide with `$ hologram`:
149
148
150
149
```shell
151
150
$ cd styleguide-theme
@@ -158,9 +157,9 @@ $ gulp
158
157
159
158
The theme is used only to present all the styles. It's not part of the styleguide. All the `!important`s were added to avoid conflict with other styles, for a better presentation.
160
159
161
-
### When I try to build with gulp I have the following error: `Syntax error: Invalid US-ASCII character "\xC3"`
160
+
### When I try to build with `$ gulp` I have the following error: `Syntax error: Invalid US-ASCII character "\xC3"`
162
161
163
-
This bug is caused by Hologram and should be fixed in the next release. The workaround is to force UTF8 by running:
0 commit comments