Skip to content
This repository was archived by the owner on Jan 18, 2022. It is now read-only.

Commit 48fbbe3

Browse files
znckznck
authored
📝 Add documentation (#50)
* 💩 Update deps and tinker circle config * 💩 Add sereno scripts * 📝 Docs are coming * 🚧 Fix circle config * 😅 Cache sereno deps for faster build * 🔧 Fix missing links * ✏️ Fix typo in comment * 📝 Remove usage guide and installation instructions * 🚧 Print current env in gulpfile.js * 📝 Add changelog to docs * 📝 Add installion guide * 📝 Add configuration guide * 💢 Use absolute path for sereno build command * 💢 Use absolute path for sereno build command * 💢 What is happening to circle? * 💢 ---- Kill it * 📝 Describe config options * 💄 Add url (og) image * 💢 Why circle? * ✨ Closing docs * 💩 Tinkering circle config
1 parent b06d645 commit 48fbbe3

25 files changed

+347
-359
lines changed

‎.github/CHANGELOG.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22

33
All Notable changes to `rollup-plugin-vue` will be documented in this file.
44

5-
## [Unreleased]
6-
7-
## [2.0.0]
5+
## [Version 2.0][2.0.0]
86

97
### Added
108
- Compile *.vue files.
119

12-
[Unreleased]: https://github.com/znck/rollup-plugin-vue/compare/v2.0.0...HEAD
1310
[2.0.0]: https://github.com/znck/rollup-plugin-vue/compare/v1.0.3...v2.0.0

‎.github/CONTRIBUTING.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ We accept contributions via Pull Requests on [Github](https://github.com/znck/ro
77

88
## Pull Requests
99

10-
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
11-
1210
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
1311

1412
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
@@ -19,9 +17,9 @@ We accept contributions via Pull Requests on [Github](https://github.com/znck/ro
1917

2018
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
2119

22-
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
20+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing.
2321

24-
- **Tip** to pass lint tests easier use the `npm run lint:fix` command
22+
- **Tip** to pass lint tests easier use the `npm run lint:fix` command.
2523

2624

2725
## Running Tests

‎build.gif renamed to ‎.github/sereno/content/assets/images/build.gif

File renamed without changes.

‎create.gif renamed to ‎.github/sereno/content/assets/images/create.gif

File renamed without changes.

‎.github/sereno/gulpfile.js

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ elixir.config.publicPath = 'content/assets';
1111
elixir(function (mix) {
1212
var env = argv.e || argv.env || 'default';
1313

14+
console.log('Using env: ' + env);
15+
1416
mix.exec('sereno build --dir=../../ -v --env=' + env, [
1517
'../../*',
1618
'../../docs/*',

‎.github/sereno/resources/views/base.blade.php

+13-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,19 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<meta name="description" content="@yield('pageDescription', $siteDescription)">
76

87
<title>@yield('pageTitle') {{$siteName}} - Rahul Kadyan</title>
8+
<meta name="og:title" content="@yield('pageTitle') {{$siteName}}">
9+
<meta name="twitter:title" content="@yield('pageTitle') {{$siteName}}">
10+
11+
<meta name="description" content="@yield('pageDescription', $siteDescription)">
12+
<meta name="og:description" content="@yield('pageDescription', $siteDescription)">
13+
<meta name="twitter:description" content="@yield('pageDescription', $siteDescription)">
14+
15+
<meta property="og:image" content="@url('assets/images/cover.png')">
16+
<meta property="twitter:image" content="@url('assets/images/cover.png')">
17+
18+
<link rel="manifest" href="/assets/icons/manifest.json">
919

1020
<link rel="apple-touch-icon" sizes="57x57" href="/assets/icons/apple-icon-57x57.png">
1121
<link rel="apple-touch-icon" sizes="60x60" href="/assets/icons/apple-icon-60x60.png">
@@ -20,7 +30,7 @@
2030
<link rel="icon" type="image/png" sizes="32x32" href="/assets/icons/favicon-32x32.png">
2131
<link rel="icon" type="image/png" sizes="96x96" href="/assets/icons/favicon-96x96.png">
2232
<link rel="icon" type="image/png" sizes="16x16" href="/assets/icons/favicon-16x16.png">
23-
<link rel="manifest" href="/assets/icons/manifest.json">
33+
2434
<meta name="msapplication-TileColor" content="#ff574a">
2535
<meta name="msapplication-TileImage" content="/assets/icons/ms-icon-144x144.png">
2636
<meta name="theme-color" content="#ff574a">
@@ -32,7 +42,7 @@
3242

3343
<body>
3444
<nav class="navbar navbar-light border-bottom">
35-
<div class="container">
45+
<div class="container fl">
3646
<a class="navbar-brand" href="@url('/')" style="margin-right: 0">
3747
{{$siteName}}
3848
</a>

‎LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The MIT License (MIT)
1+
# The MIT License (MIT)
22

3-
Copyright (c) 2016 Rahul Kadyan
3+
Copyright (c) 2016 Rahul Kadyan, <[email protected]>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

+7-112
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@ As vue-loader is for webpack and vueify is for browserify, similarly its for rol
33

44
With rollup you can break your application into reusable modules.
55

6-
> See [docs](http://znck.me/rollup-plugin-vue) for installing, using and contributing.
6+
> See [docs](http://znck.me/rollup-plugin-vue/installation) for installing, using and contributing.
77
8-
![Rollup Plugin for Vue](http://znck.me/rollup-plugin-vue/content/assets/images/cover.png)
8+
![Rollup Plugin for Vue](http://znck.me/rollup-plugin-vue/assets/images/cover.png)
99

1010
<p align="center">
1111
<a href="https://circleci.com/gh/znck/rollup-plugin-vue">
1212
<img src="https://circleci.com/gh/znck/rollup-plugin-vue.svg?style=svg" alt="Build Status" />
1313
</a>
14+
<a href="http://standardjs.com">
15+
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="Code Style" />
16+
</a>
1417
<a href="https://coveralls.io/github/znck/rollup-plugin-vue?branch=master">
1518
<img src="https://coveralls.io/repos/github/znck/rollup-plugin-vue/badge.svg?branch=master&style=flat-square" alt="Coverage Status" />
1619
</a>
@@ -32,114 +35,6 @@ With rollup you can break your application into reusable modules.
3235
</a>
3336
</p>
3437

35-
## Quick Start
36-
37-
Create project with vue-cli!
38-
39-
```
40-
vue init znck/vue-plugin-simple my-project
41-
```
42-
43-
Rollup! Rollup! Rollup!
44-
45-
### Create new project
46-
![](create.gif)
47-
48-
### Install dependencies & build
49-
![](build.gif)
50-
51-
52-
## Usage
53-
54-
```js
55-
import {rollup} from 'rollup';
56-
import vue from 'rollup-plugin-vue';
57-
58-
rollup({
59-
entry: 'index.js',
60-
plugins: [vue()]
61-
});
62-
```
63-
64-
Below is how you can use it from the command line with Bublé.
65-
Run `rollup -c` and it will find the config.
66-
67-
```js
68-
// rollup.config.js
69-
import vue from 'rollup-plugin-vue'
70-
import buble from 'rollup-plugin-buble' // rollup-plugin-babel also works
71-
72-
export default {
73-
entry: 'index.js',
74-
plugins: [
75-
vue(),
76-
buble()
77-
]
78-
}
79-
```
80-
81-
### Examples
82-
83-
- [Vue 2.0 application](https://gist.github.com/znck/4ae3a705bccba0a3feecfa7b5f3da1ea)
84-
- [Vue component module/package](https://gist.github.com/znck/140d5e9deabfa41f2e935d053a59f23e)
85-
86-
### Options
87-
88-
#### `css`
89-
90-
```js
91-
vue({
92-
// Filename to write all styles to
93-
css: 'bundle.scss',
94-
95-
// Callback that will be called ongenerate with two arguments:
96-
// - styles: the contents of all style tags combined
97-
// - styleNodes: an array of style objects: [{lang: 'css', content: 'body { color: green }'}]
98-
css: function (styles, styleNodes) {
99-
writeFileSync(cssPath, styles)
100-
}
101-
102-
// Disable any style output or callbacks
103-
css: false,
104-
105-
// Default behaviour is to write all styles to the bundle destination where .js is replaced by .css
106-
css: null
107-
})
108-
```
109-
110-
#### `compileTemplate`
111-
112-
```js
113-
vue({
114-
// Compile templates to render functions (Vue 2 only)
115-
compileTemplate: true,
116-
})
117-
```
118-
119-
#### `htmlMinifier`
120-
121-
Use any option from [https://github.com/kangax/html-minifier](https://github.com/kangax/html-minifier)
122-
123-
```js
124-
vue({
125-
htmlMinifier: {}
126-
})
127-
```
128-
129-
## Change log
130-
131-
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
132-
133-
## Testing
134-
135-
``` bash
136-
$ npm run test
137-
```
138-
139-
## Contributing
140-
141-
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
142-
14338
## Security
14439

14540
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
@@ -153,6 +48,6 @@ If you discover any security related issues, please email [email protected] instead of
15348

15449
## License
15550

156-
The MIT License (MIT). Please see [License File](LICENSE) for more information.
51+
The MIT License (MIT). Please see [License File](http://znck.me/rollup-plugin-vue/license) for more information.
15752

158-
[link-contributors]: ../../contributors
53+
[link-contributors]: https://github.com/znck/rollup-plugin-vue/graphs/contributors

‎circle.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
machine:
22
php:
33
version: 7.0.4
4+
node:
5+
version: 5.6.0
46

57
dependencies:
68
pre:
79
- curl -o- -s -L https://yarnpkg.com/install.sh | bash
10+
- export COMPOSER_HOME=$HOME/.composer
11+
- composer global require --no-progress sereno/installer
812
override:
9-
- mkdir -p build/logs
10-
- composer global require sereno/installer
1113
- yarn --no-progress
1214
cache_directories:
1315
- "~/.yarn-cache"
@@ -23,5 +25,4 @@ deployment:
2325
- master
2426
- documentation
2527
commands:
26-
- composer global require --no-progress sereno/installer
2728
- sereno deploy

‎docs/advance.md

-7
This file was deleted.

‎docs/changelog.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22

33
All Notable changes to `rollup-plugin-vue` will be documented in this file.
44

5-
## [Unreleased]
6-
7-
## [2.0.0]
5+
## [Version 2.0][2.0.0]
86

97
### Added
108
- Compile *.vue files.
119

12-
[Unreleased]: https://github.com/znck/rollup-plugin-vue/compare/v2.0.0...HEAD
1310
[2.0.0]: https://github.com/znck/rollup-plugin-vue/compare/v1.0.3...v2.0.0

0 commit comments

Comments
 (0)