Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.md

Issue 29822574: Added to README (Closed) Base URL: https://hg.adblockplus.org/website-defaults
Patch Set: Created July 4, 2018, 2:37 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # Website defaults 1 # Website defaults
2 2
3 Default resources for eyeo websites. 3 Default resources for eyeo websites.
4 4
5 ## How to use website-defaults
6
7 ### In [eyeo/cms](https://gitlab.com/eyeo/websites/cms) websites
8
9 All website-default resources can be used as-if they were local resources in any [eyeo/cms](https://gitlab.com/eyeo/websites/cms) generated website by configuri ng `additional-paths` inside `settings.ini`.
10
11 1. Install website-defaults as a dependency
12
13 `npm i --save gitlab:eyeo/websites/website-defaults`
14
15 2. Add website-defaults dependency to `settings.ini` `additional-paths` list
16
17 ```
18 [paths]
19 additional-paths =
20 node_modules/website-defaults
21 ```
22
23 ### In any website
24
25 One may also choose to include the SCSS resources in `website-defaults/static/sc ss` into any other website build proceedure.
26
27 ## Why to use website-defaults
28
29 website-defaults provides shared resources for eyeo websites.
30
31 Shared resources enable eyeo website developers to develop and maintain one copy of commonly used resources and components instead of several.
32
33 Shared resources also enable eyeo website developers to build new websites faste r when they use and / or remix previously established UI patterns.
34
35 ## Why not use another framework / library?
36
37 1. Because they overkill eyeo websites
38 1. Because we want to avoid specializing
39
40 We are not against using another framework / library when it's appropriate.
41
5 ## License 42 ## License
6 43
7 - CSS Reset (scss/_reset.scss) based on [Eric Meyer's CSS Reset](http://meyerweb .com/eric/tools/css/reset/): Public Domain 44 - CSS Reset (scss/_reset.scss) based on [Eric Meyer's CSS Reset](http://meyerweb .com/eric/tools/css/reset/): Public Domain
8 - Form styles (scss/forms) based on normalize.css: [MIT License](https://github. com/necolas/normalize.css/blob/master/LICENSE.md) by Nicolas Gallagher and Jonat han Neal 45 - Form styles (scss/forms) based on normalize.css: [MIT License](https://github. com/necolas/normalize.css/blob/master/LICENSE.md) by Nicolas Gallagher and Jonat han Neal
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld