1
- < img src = " https://github.com/vitto/ a-pollo/raw/master/frontend/frontsize/a-pollo/img/a-pollo- logo.png " width = " 64 " >
1
+ ![ ] [ a-pollo- logo ]
2
2
3
- a-pollo
4
- ---
3
+ # a-pollo
5
4
6
- [ ![ Version] ( http://img.shields.io/:version-1.18.99-B79769.svg )] [ release ]
7
- [ ![ TravisCI] ( https://travis-ci.org/vitto/a-pollo.svg?branch=master )] ( https://travis-ci.org/vitto/a-pollo/builds )
8
- [ ![ Built with nodejs 4.2.2] ( http://img.shields.io/:nodejs-4.2.2-80BD01.svg )] ( https://nodejs.org/en/ )
9
- [ ![ NPM] ( http://img.shields.io/:NPM-package-C12127.svg )] ( https://www.npmjs.com/package/a-pollo )
10
- [ ![ Built with hexo 3.2.0] ( http://img.shields.io/:hexo-3.2.0-0E83CD.svg )] ( https://hexo.io/ )
11
- [ ![ MIT licence] ( http://img.shields.io/:license-MIT-00AFFF.svg )] ( https://github.com/ideatosrl/frontsize-sass/blob/master/LICENSE.md )
5
+ [ ![ Version] ( http://img.shields.io/:version-1.18.99-B79769.svg )] [ release ] [ ![ TravisCI] ( https://travis-ci.org/vitto/a-pollo.svg?branch=master )] ( https://travis-ci.org/vitto/a-pollo/builds ) [ ![ Built with nodejs 4.2.2] ( http://img.shields.io/:nodejs-4.2.2-80BD01.svg )] ( https://nodejs.org/en/ ) [ ![ NPM] ( http://img.shields.io/:NPM-package-C12127.svg )] ( https://www.npmjs.com/package/a-pollo ) [ ![ Built with hexo 3.2.0] ( http://img.shields.io/:hexo-3.2.0-0E83CD.svg )] ( https://hexo.io/ ) [ ![ MIT licence] ( http://img.shields.io/:license-MIT-00AFFF.svg )] ( https://github.com/ideatosrl/frontsize-sass/blob/master/LICENSE.md )
12
6
13
7
A-pollo generates ** CSS style guide documentation** from your [ code comments] [ apollo_code_docs ] .
14
8
15
9
It's been written for teams who need to check CSS widgets with examples, copy html related code with no pain to go through browser HTML debugger.
16
10
17
- ---
11
+ --------------------------------------------------------------------------------
18
12
19
- ##### Release notes
13
+ ## Release notes
20
14
21
15
- Documentation annotations support
22
16
- Remove use_markdown var from config
@@ -27,9 +21,9 @@ It's been written for teams who need to check CSS widgets with examples, copy ht
27
21
28
22
![ a-pollo preview] [ a-pollo-preview ]
29
23
30
- ---
24
+ --------------------------------------------------------------------------------
31
25
32
- ##### Roadmap
26
+ ## Roadmap
33
27
34
28
- Default style guide articles for CSS
35
29
- Default style guide articles for HTML
@@ -38,21 +32,21 @@ It's been written for teams who need to check CSS widgets with examples, copy ht
38
32
- Documentation tags for SASS
39
33
- Documentation tags for LESS
40
34
41
- ---
35
+ --------------------------------------------------------------------------------
42
36
43
- The module works with [ Hexo] [ hexo ] , an easy to use and powerful blog framework, so if you'd like to [ write your own theme] [ apollo_theme ] you'll have the power this nice tool in your fingers.
37
+ The module works with [ Hexo] , an easy to use and powerful blog framework, so if you'd like to [ write your own theme] [ apollo_theme ] you'll have the power this nice tool in your fingers.
44
38
45
- ---
39
+ --------------------------------------------------------------------------------
46
40
47
- ### To install a-pollo in your project
41
+ ## To install a-pollo in your project
48
42
49
43
```
50
44
npm install --save a-pollo
51
45
```
52
46
53
- ---
47
+ --------------------------------------------------------------------------------
54
48
55
- ### To create a config file
49
+ ## To create a config file
56
50
57
51
From ` package.json ` where you have installed ` node_modules ` folder
58
52
@@ -62,19 +56,19 @@ From `package.json` where you have installed `node_modules` folder
62
56
63
57
It will start a process will help you to build the first one.
64
58
65
- ---
59
+ --------------------------------------------------------------------------------
66
60
67
- ### To run a-pollo
61
+ ## To run a-pollo
68
62
69
63
From ` package.json ` where you have installed ` node_modules ` folder
70
64
71
65
```
72
66
./node_modules/.bin/a-pollo
73
67
```
74
68
75
- ---
69
+ --------------------------------------------------------------------------------
76
70
77
- ### Doc style guide example
71
+ ## Doc style guide example
78
72
79
73
This will be placed on ` style.docs ` files defined in the YAML configuration.
80
74
@@ -90,11 +84,11 @@ This will be placed on `style.docs` files defined in the YAML configuration.
90
84
*/
91
85
```
92
86
93
- ---
87
+ --------------------------------------------------------------------------------
94
88
95
89
Place a ` a-pollo.yml ` in the root folder of your project, this is the default config:
96
90
97
- ``` yaml
91
+ ``` yaml
98
92
title : ' Client project' # [required] Will be listened on head's title tag
99
93
client : ' [Client name](http://github.com/vitto/a-pollo#readme)'
100
94
developers : ' [Vittorio Vittori](http://vit.to), [Pietro Campagnano](https://twitter.com/fain182)' # [required] Who's managing the style guide
@@ -128,95 +122,94 @@ footer:
128
122
logo : a-pollo-logo.svg # [optional] The logo image you'll se on every page, it must be stored in style.images
129
123
link : http://vitto.github.io/a-pollo/ # [optional] The link on the logo image
130
124
description : A-POLLO / The visual CSS style guide for teams # [optional] A description under the logo image
131
-
132
125
` ` `
133
126
134
- ---
135
-
136
- #### Configuration
137
-
138
- | Property | Hexo's shared config | Description |
139
- | --- | --- | --- |
140
- | ` title ` | ** yes** | Will be shown on HTML page title |
141
- | ` author ` | ** yes** | Will be shown around the pages |
142
- | ` date ` | ** yes** | Not yet used |
143
- | ` public_dir ` | ** yes** | The target path the site will be generated |
144
- | ` url ` | ** yes** | HTTP server URL |
145
- | ` theme ` | ** yes** | Theme folder name, you can [ write your own theme] [ apollo_theme ] |
146
- | ` pages ` | * no * | The customized markdown pages will be published from Hexo |
147
- | ` http_server ` | * no * | If the generated guide will be served by the HTTP server |
148
- | ` use_markdown ` | * no * | Which method will be used to render the HTML template pages |
149
- | ` style.docs ` | * no * | The path where the documentation files are |
150
- | ` style.css ` | * no * | The path where the CSS for the documentation is, this is not the CSS of the a-pollo theme |
151
- | ` style.images ` | * no * | Image assets for the CSS you are using |
152
- | ` style.fonts ` | * no * | Fonts assets for the CSS you are using |
153
- | ` header.logo ` | * no * | An image inside ` style.images ` to be used as image header inside a-pollo theme |
154
- | ` header.description ` | * no * | The header description inside a-pollo theme |
155
- | ` header.link ` | * no * | The header logo href link |
156
- | ` footer.logo ` | * no * | An image inside ` style.images ` to be used as image footer inside a-pollo theme |
157
- | ` footer.description ` | * no * | The footer description inside a-pollo theme |
158
- | ` footer.link ` | * no * | The footer logo href link |
159
- | ` libs.bower ` | * no * | Location of the ` bower.json ` file to display Bower used libraries in the index page |
160
- | ` libs.node ` | * no * | Location of the ` package.json ` file to display NodeJS used libraries in the index page |
161
-
162
- ---
163
-
164
- ##### Development utils
127
+ --------------------------------------------------------------------------------
128
+
129
+ ### Configuration
130
+
131
+ Property | Hexo's shared config | Description
132
+ -------------------- | -------------------- | -----------------------------------------------------------------------------------------
133
+ ` title` | **yes** | Will be shown on HTML page title
134
+ ` author` | **yes** | Will be shown around the pages
135
+ ` date` | **yes** | Not yet used
136
+ ` public_dir` | **yes** | The target path the site will be generated
137
+ ` url` | **yes** | HTTP server URL
138
+ ` theme` | **yes** | Theme folder name, you can [write your own theme][apollo_theme]
139
+ ` pages` | _no_ | The customized markdown pages will be published from Hexo
140
+ ` http_server` | _no_ | If the generated guide will be served by the HTTP server
141
+ ` use_markdown` | _no_ | Which method will be used to render the HTML template pages
142
+ ` style.docs` | _no_ | The path where the documentation files are
143
+ ` style.css` | _no_ | The path where the CSS for the documentation is, this is not the CSS of the a-pollo theme
144
+ ` style.images` | _no_ | Image assets for the CSS you are using
145
+ ` style.fonts` | _no_ | Fonts assets for the CSS you are using
146
+ ` header.logo` | _no_ | An image inside `style.images` to be used as image header inside a-pollo theme
147
+ ` header.description` | _no_ | The header description inside a-pollo theme
148
+ ` header.link` | _no_ | The header logo href link
149
+ ` footer.logo` | _no_ | An image inside `style.images` to be used as image footer inside a-pollo theme
150
+ ` footer.description` | _no_ | The footer description inside a-pollo theme
151
+ ` footer.link` | _no_ | The footer logo href link
152
+ ` libs.bower` | _no_ | Location of the `bower.json` file to display Bower used libraries in the index page
153
+ ` libs.node` | _no_ | Location of the `package.json` file to display NodeJS used libraries in the index page
154
+
155
+ --------------------------------------------------------------------------------
156
+
157
+ # ### Development utils
165
158
166
159
Prepare environment
167
160
168
161
```
169
162
npm install && ./node_modules/.bin/bower install && cd test && npm install && ./node_modules/.bin/bower install
170
163
```
171
164
172
- ---
165
+ --------------------------------------------------------------------------------
173
166
174
167
To build theme
175
168
176
169
```
177
- ./node_modules/.bin/gulp frontsize:build
170
+ ./node_modules/.bin/gulp -s
178
171
```
179
172
180
- ---
173
+ --------------------------------------------------------------------------------
181
174
182
175
Generate test CSS
183
176
184
177
```
185
- ./node_modules/.bin/gulp frontsize:build && cd ./test && ./node_modules/.bin/gulp frontsize:css && ../ && node index.js --config a-pollo.test.yml
178
+ ./node_modules/.bin/gulp -s && cd ./test && ./node_modules/.bin/gulp frontsize: css && ../ && node index.js --config a-pollo.test.yml
186
179
```
187
180
188
181
Generate website example CSS
189
182
190
183
```
191
- ./node_modules/.bin/gulp frontsize:build && cd ./test && ./node_modules/.bin/gulp frontsize:css && ../ && node index.js --config a-pollo.example.yml
184
+ ./node_modules/.bin/gulp -s && cd ./test && ./node_modules/.bin/gulp frontsize: css && ../ && node index.js --config a-pollo.example.yml
192
185
```
193
186
194
- ---
187
+ --------------------------------------------------------------------------------
195
188
196
189
To test the HTML results
197
190
198
191
```
199
- ./node_modules/.bin/gulp frontsize:build && node index.js
200
- ./node_modules/.bin/gulp frontsize:build && node index.js --config a-pollo.test.yml
201
- ./node_modules/.bin/gulp frontsize:build && node index.js --config a-pollo.example.yml
192
+ ./node_modules/.bin/gulp -s && node index.js
193
+ ./node_modules/.bin/gulp -s && node index.js --config a-pollo.test.yml
194
+ ./node_modules/.bin/gulp -s && node index.js --config a-pollo.example.yml
202
195
```
203
196
204
- ---
197
+ --------------------------------------------------------------------------------
205
198
206
199
Generate website
207
200
208
201
```
209
- ./node_modules/.bin/gulp frontsize:build && cd ./hexo && ../node_modules/.bin/hexo --config _site_config.yml generate && cd ../ && php -S localhost:8000 -t ./_site
202
+ ./node_modules/.bin/gulp -s && cd ./hexo && ../node_modules/.bin/hexo --config _ site_config.yml generate && cd ../ && php -S localhost:8000 -t ./_ site
210
203
```
211
204
212
205
Coded with love by [Vittorio Vittori][vitto] and [Pietro Campagnano][pietro] @ [ideato srl][ideato]
213
206
214
- [ vitto ] : https://twitter.com/vttrx
215
- [ pietro ] : https://twitter.com/fain182
216
- [ ideato ] : http://www.ideato.it
217
- [ hexo ] : https://hexo.io
207
+ [a-pollo-logo]: https://github.com/vitto/a-pollo/raw/master/frontend/frontsize/a-pollo/img/a-pollo-logo.png
208
+ [a-pollo-preview]: https://github.com/vitto/a-pollo/raw/master/frontend/frontsize/a-pollo/img/apollo-example.png
218
209
[apollo_code_docs]: https://github.com/vitto/a-pollo/blob/master/example_source/frontsize/themes/default/widgets/button-social.scss
219
210
[apollo_theme]: https://github.com/vitto/a-pollo/tree/master/hexo/themes/a-pollo
211
+ [hexo]: https://hexo.io
212
+ [ideato]: http://www.ideato.it
213
+ [pietro]: https://twitter.com/fain182
220
214
[release]: https://github.com/vitto/a-pollo/releases/tag/1.18.99
221
- [ a-pollo-preview ] : https://github.com/vitto/a-pollo/raw/master/frontend/frontsize/a-pollo/img/apollo-example.png
222
- [ a-pollo-logo ] : https://github.com/vitto/a-pollo/raw/master/frontend/frontsize/a-pollo/img/a-pollo-logo.png
215
+ [vitto]: https://twitter.com/vttrx
0 commit comments