Skip to content
This repository was archived by the owner on Aug 27, 2019. It is now read-only.

Commit 0722e30

Browse files
author
Vittorio Vittori
committed
Moved test assets to test folder
1 parent 9f526a1 commit 0722e30

File tree

123 files changed

+130
-111
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+130
-111
lines changed

README.md

Lines changed: 67 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
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]
22

3-
a-pollo
4-
---
3+
# a-pollo
54

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)
126

137
A-pollo generates **CSS style guide documentation** from your [code comments][apollo_code_docs].
148

159
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.
1610

17-
---
11+
--------------------------------------------------------------------------------
1812

19-
##### Release notes
13+
## Release notes
2014

2115
- Documentation annotations support
2216
- 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
2721

2822
![a-pollo preview][a-pollo-preview]
2923

30-
---
24+
--------------------------------------------------------------------------------
3125

32-
##### Roadmap
26+
## Roadmap
3327

3428
- Default style guide articles for CSS
3529
- 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
3832
- Documentation tags for SASS
3933
- Documentation tags for LESS
4034

41-
---
35+
--------------------------------------------------------------------------------
4236

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.
4438

45-
---
39+
--------------------------------------------------------------------------------
4640

47-
### To install a-pollo in your project
41+
## To install a-pollo in your project
4842

4943
```
5044
npm install --save a-pollo
5145
```
5246

53-
---
47+
--------------------------------------------------------------------------------
5448

55-
### To create a config file
49+
## To create a config file
5650

5751
From `package.json` where you have installed `node_modules` folder
5852

@@ -62,19 +56,19 @@ From `package.json` where you have installed `node_modules` folder
6256

6357
It will start a process will help you to build the first one.
6458

65-
---
59+
--------------------------------------------------------------------------------
6660

67-
### To run a-pollo
61+
## To run a-pollo
6862

6963
From `package.json` where you have installed `node_modules` folder
7064

7165
```
7266
./node_modules/.bin/a-pollo
7367
```
7468

75-
---
69+
--------------------------------------------------------------------------------
7670

77-
### Doc style guide example
71+
## Doc style guide example
7872

7973
This will be placed on `style.docs` files defined in the YAML configuration.
8074

@@ -90,11 +84,11 @@ This will be placed on `style.docs` files defined in the YAML configuration.
9084
*/
9185
```
9286

93-
---
87+
--------------------------------------------------------------------------------
9488

9589
Place a `a-pollo.yml` in the root folder of your project, this is the default config:
9690

97-
``` yaml
91+
```yaml
9892
title: 'Client project' # [required] Will be listened on head's title tag
9993
client: '[Client name](http://github.com/vitto/a-pollo#readme)'
10094
developers: '[Vittorio Vittori](http://vit.to), [Pietro Campagnano](https://twitter.com/fain182)' # [required] Who's managing the style guide
@@ -128,95 +122,94 @@ footer:
128122
logo: a-pollo-logo.svg # [optional] The logo image you'll se on every page, it must be stored in style.images
129123
link: http://vitto.github.io/a-pollo/ # [optional] The link on the logo image
130124
description: A-POLLO / The visual CSS style guide for teams # [optional] A description under the logo image
131-
132125
```
133126
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
165158

166159
Prepare environment
167160

168161
```
169162
npm install && ./node_modules/.bin/bower install && cd test && npm install && ./node_modules/.bin/bower install
170163
```
171164
172-
---
165+
--------------------------------------------------------------------------------
173166
174167
To build theme
175168
176169
```
177-
./node_modules/.bin/gulp frontsize:build
170+
./node_modules/.bin/gulp -s
178171
```
179172
180-
---
173+
--------------------------------------------------------------------------------
181174
182175
Generate test CSS
183176
184177
```
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
186179
```
187180
188181
Generate website example CSS
189182
190183
```
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
192185
```
193186
194-
---
187+
--------------------------------------------------------------------------------
195188
196189
To test the HTML results
197190
198191
```
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
202195
```
203196
204-
---
197+
--------------------------------------------------------------------------------
205198
206199
Generate website
207200
208201
```
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
210203
```
211204
212205
Coded with love by [Vittorio Vittori][vitto] and [Pietro Campagnano][pietro] @ [ideato srl][ideato]
213206
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
218209
[apollo_code_docs]: https://github.com/vitto/a-pollo/blob/master/example_source/frontsize/themes/default/widgets/button-social.scss
219210
[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
220214
[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

a-pollo.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ date_format: dddd D MMMM YYYY # [optional] Default from hexo config YYYY-MM-D
1111

1212
public_dir: ./public # [required] Where the style guide will be genarated
1313
url: http://localhost:7777 # [optional] HTTP server URL
14-
#pages: example_source/a-pollo/* # [optional] Additional static documentation pages you want to add, (markdown or html)
14+
#pages: test/examples/a-pollo/* # [optional] Additional static documentation pages you want to add, (markdown or html)
1515
http_server: true # [optional] HTTP server with port number
1616
use_markdown: false # [optional] This will be removed soon, it's used for development
1717
theme: miniml # [optional] The a-pollo theme folder
1818

1919
libs:
20-
bower: bower.json # [optional] Link the bower.json file to display Bower used libraries in the index page
21-
node: package.json # [optional] Link the package.json file to display NodeJS used libraries in the index page
20+
bower: bower.json # [optional] Link the bower.json file to display Bower used libraries in the index page
21+
node: package.json # [optional] Link the package.json file to display NodeJS used libraries in the index page
2222

2323
style:
24-
docs: example_source/frontsize/themes/default/ # [required] Where a-pollo comments and tags are placed
25-
css: example_source/frontsize/test/css/frontsize-theme.min.css # [required] This is the CSS will be loaded by a-pollo to show rendered widgets
26-
images: example_source/frontsize/themes/default/img/* # [optional] Where the CSS images are stored
27-
fonts: example_source/frontsize/themes/default/fonts/* # [optional] Where the CSS fonts are stored
24+
docs: test/examples/frontsize/themes/default/ # [required] Where a-pollo comments and tags are placed
25+
css: test/examples/frontsize/test/css/frontsize-theme.min.css # [required] This is the CSS will be loaded by a-pollo to show rendered widgets
26+
images: test/examples/frontsize/themes/default/img/* # [optional] Where the CSS images are stored
27+
fonts: test/examples/frontsize/themes/default/fonts/* # [optional] Where the CSS fonts are stored
2828

2929
header:
3030
logo: a-pollo-logo--gold.svg # [optional] The logo image you'll se on every page, it must be stored in style.images

frontend/frontsize/miniml/widgets/index/miniml-map-dot.scss

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
margin-bottom: s(0.25);
2626
margin-right: s(0.25);
2727
position: relative;
28-
transition: border $ease-hover;
2928
width: $map-dot-size;
3029

3130
&::before {

hexo/themes/miniml/layout/_partial/head.ejs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@
1515
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
1616

1717
<% if (theme.favicon){ %>
18-
<link href="<%= config.url %>/img/icon/apple-touch-icon-57x57.png" rel="apple-touch-icon" sizes="57x57">
19-
<link href="<%= config.url %>/img/icon/apple-touch-icon-60x60.png" rel="apple-touch-icon" sizes="60x60">
20-
<link href="<%= config.url %>/img/icon/apple-touch-icon-72x72.png" rel="apple-touch-icon" sizes="72x72">
21-
<link href="<%= config.url %>/img/icon/apple-touch-icon-76x76.png" rel="apple-touch-icon" sizes="76x76">
22-
<link href="<%= config.url %>/img/icon/apple-touch-icon-114x114.png" rel="apple-touch-icon" sizes="114x114">
23-
<link href="<%= config.url %>/img/icon/apple-touch-icon-120x120.png" rel="apple-touch-icon" sizes="120x120">
24-
<link href="<%= config.url %>/img/icon/apple-touch-icon-144x144.png" rel="apple-touch-icon" sizes="144x144">
25-
<link href="<%= config.url %>/img/icon/apple-touch-icon-152x152.png" rel="apple-touch-icon" sizes="152x152">
26-
<link href="<%= config.url %>/img/icon/favicon-16x16.png" rel="icon" sizes="16x16" type="image/png">
27-
<link href="<%= config.url %>/img/icon/favicon-32x32.png" rel="icon" sizes="32x32" type="image/png">
28-
<link href="<%= config.url %>/img/icon/favicon-96x96.png" rel="icon" sizes="96x96" type="image/png">
29-
<link href="<%= config.url %>/img/icon/favicon-160x160.png" rel="icon" sizes="160x160" type="image/png">
30-
<link href="<%= config.url %>/img/icon/favicon-196x196.png" rel="icon" sizes="196x196" type="image/png">
18+
<link href="img/icon/apple-touch-icon-57x57.png" rel="apple-touch-icon" sizes="57x57">
19+
<link href="img/icon/apple-touch-icon-60x60.png" rel="apple-touch-icon" sizes="60x60">
20+
<link href="img/icon/apple-touch-icon-72x72.png" rel="apple-touch-icon" sizes="72x72">
21+
<link href="img/icon/apple-touch-icon-76x76.png" rel="apple-touch-icon" sizes="76x76">
22+
<link href="img/icon/apple-touch-icon-114x114.png" rel="apple-touch-icon" sizes="114x114">
23+
<link href="img/icon/apple-touch-icon-120x120.png" rel="apple-touch-icon" sizes="120x120">
24+
<link href="img/icon/apple-touch-icon-144x144.png" rel="apple-touch-icon" sizes="144x144">
25+
<link href="img/icon/apple-touch-icon-152x152.png" rel="apple-touch-icon" sizes="152x152">
26+
<link href="img/icon/favicon-16x16.png" rel="icon" sizes="16x16" type="image/png">
27+
<link href="img/icon/favicon-32x32.png" rel="icon" sizes="32x32" type="image/png">
28+
<link href="img/icon/favicon-96x96.png" rel="icon" sizes="96x96" type="image/png">
29+
<link href="img/icon/favicon-160x160.png" rel="icon" sizes="160x160" type="image/png">
30+
<link href="img/icon/favicon-196x196.png" rel="icon" sizes="196x196" type="image/png">
3131
<meta content="#B89766" name="msapplication-TileColor">
32-
<meta content="<%= config.url %>/img/icon/mstile-144x144.png" name="msapplication-TileImage">
32+
<meta content="img/icon/mstile-144x144.png" name="msapplication-TileImage">
3333
<% } %>
3434
<%- css('css/dustman.frontsize.min') %>
3535
<%- css('css/theme/theme') %>

hexo/themes/miniml/layout/_partial/index/map.ejs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55

66
<div class="miniml-map">
77

8-
<%- partial('_partial/index/map__labels') %>
8+
<%- partial('_partial/index/map__labels', {
9+
elements: site.tags
10+
}) %>
911

1012
<div class="miniml-map__dots">
1113
<%- partial('_partial/index/map__dots--category-snippet', {

hexo/themes/miniml/layout/_partial/index/map__labels.ejs

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,30 @@
22
<div class="miniml-map__label miniml-map__label--category">
33
<div>
44
<div>
5-
<span class="miniml-map-dot miniml-map-dot--label miniml-map-dot--no-margin miniml-map-dot--category-snippet"></span>
6-
<span class="miniml-map-dot miniml-map-dot--label miniml-map-dot--no-margin miniml-map-dot--category-doc"></span>
5+
<span class="miniml-map-dot miniml-map-dot--label miniml-map-dot--no-margin miniml-map-dot--category-snippet">
6+
<% var categories = 0; %>
7+
<% elements.each(function(element, i) { %>
8+
<% if (element.posts.data[0].layout === 'snippet') { %>
9+
<% categories += 1; %>
10+
<% } %>
11+
<% }) %>
12+
<%= categories %>
13+
<span class="miniml-tip">
14+
snippet
15+
</span>
16+
</span>
17+
<span class="miniml-map-dot miniml-map-dot--label miniml-map-dot--no-margin miniml-map-dot--category-doc">
18+
<% categories = 0; %>
19+
<% elements.each(function(element, i) { %>
20+
<% if (element.posts.data[0].layout === 'doc') { %>
21+
<% categories += 1; %>
22+
<% } %>
23+
<% }) %>
24+
<%= categories %>
25+
<span class="miniml-tip">
26+
doc
27+
</span>
28+
</span>
729
</div>
830
<div>
931
Categories

0 commit comments

Comments
 (0)