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

Commit 20a78ec

Browse files
znckznck
committed
💩 Add docs and fix #49 
1 parent 166c061 commit 20a78ec

27 files changed

+5464
-90
lines changed

‎CHANGELOG.md renamed to ‎.github/CHANGELOG.md

File renamed without changes.

‎CONDUCT.md renamed to ‎.github/CONDUCT.md

File renamed without changes.

‎CONTRIBUTING.md renamed to ‎.github/CONTRIBUTING.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Expected behavior
2+
3+
### Actual behavior
4+
5+
### Steps to reproduce the behavior

‎.github/PULL_REQUEST_TEMPLATE.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Fixes #.
2+
3+
Changes proposed in this pull request:
4+
-
5+
-
6+
-
7+
8+
/ping @znck

‎cover.png renamed to ‎.github/sereno/content/assets/images/cover.png

File renamed without changes.

‎.github/sereno/gulpfile.js

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
if (process.env.CIRCLECI) {
2+
process.env.DISABLE_NOTIFIER = true;
3+
}
4+
5+
var gulp = require('gulp');
6+
var elixir = require('laravel-elixir');
7+
var argv = require('yargs').argv;
8+
9+
elixir.config.publicPath = 'content/assets';
10+
11+
elixir(function (mix) {
12+
var env = argv.e || argv.env || 'default';
13+
14+
mix.exec('sereno build --dir=../../ -v --env=' + env, [
15+
'../../*',
16+
'../../docs/*',
17+
'../../docs/**/*',
18+
'content/*',
19+
'content/**/*',
20+
'resources/*',
21+
'resources/**/*',
22+
])
23+
.browserSync({
24+
server: {
25+
baseDir: 'public'
26+
},
27+
proxy: null,
28+
files: ['public/**/*']
29+
});
30+
});

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

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta name="description" content="@yield('pageDescription', $siteDescription)">
7+
8+
<title>@yield('pageTitle') {{$siteName}} - Rahul Kadyan</title>
9+
10+
<link rel="apple-touch-icon" sizes="57x57" href="/assets/icons/apple-icon-57x57.png">
11+
<link rel="apple-touch-icon" sizes="60x60" href="/assets/icons/apple-icon-60x60.png">
12+
<link rel="apple-touch-icon" sizes="72x72" href="/assets/icons/apple-icon-72x72.png">
13+
<link rel="apple-touch-icon" sizes="76x76" href="/assets/icons/apple-icon-76x76.png">
14+
<link rel="apple-touch-icon" sizes="114x114" href="/assets/icons/apple-icon-114x114.png">
15+
<link rel="apple-touch-icon" sizes="120x120" href="/assets/icons/apple-icon-120x120.png">
16+
<link rel="apple-touch-icon" sizes="144x144" href="/assets/icons/apple-icon-144x144.png">
17+
<link rel="apple-touch-icon" sizes="152x152" href="/assets/icons/apple-icon-152x152.png">
18+
<link rel="apple-touch-icon" sizes="180x180" href="/assets/icons/apple-icon-180x180.png">
19+
<link rel="icon" type="image/png" sizes="192x192" href="/assets/icons/android-icon-192x192.png">
20+
<link rel="icon" type="image/png" sizes="32x32" href="/assets/icons/favicon-32x32.png">
21+
<link rel="icon" type="image/png" sizes="96x96" href="/assets/icons/favicon-96x96.png">
22+
<link rel="icon" type="image/png" sizes="16x16" href="/assets/icons/favicon-16x16.png">
23+
<link rel="manifest" href="/assets/icons/manifest.json">
24+
<meta name="msapplication-TileColor" content="#ff574a">
25+
<meta name="msapplication-TileImage" content="/assets/icons/ms-icon-144x144.png">
26+
<meta name="theme-color" content="#ff574a">
27+
<meta name="apple-mobile-web-app-capable" content="yes">
28+
<meta name="mobile-web-app-capable" content="yes">
29+
30+
<link rel="stylesheet" href="http://znck.me/assets/css/app.css">
31+
</head>
32+
33+
<body>
34+
<nav class="navbar navbar-light border-bottom">
35+
<div class="container">
36+
<a class="navbar-brand" href="@url('/')" style="margin-right: 0">
37+
{{$siteName}}
38+
</a>
39+
<a class="navbar-brand" href="http://znck.me/">
40+
<span style="color: rgba(0, 0, 0, 0.25);">&nbsp;| Rahul Kadyan</span>
41+
</a>
42+
<div>
43+
<div class="clearfix hidden-lg-up">
44+
<a role="button" class="navbar-toggler float-xs-right" data-toggle="collapse"
45+
data-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false"
46+
aria-label="Toggle navigation"></a>
47+
</div>
48+
<div class="collapse navbar-toggleable-md" id="navbarResponsive">
49+
<ul class="nav navbar-nav float-lg-right">
50+
@include('nav')
51+
</ul>
52+
@yield('extra-nav')
53+
</div>
54+
</div>
55+
</div>
56+
</nav>
57+
58+
<div class="body" style="min-height: 70vh">
59+
@yield('body')
60+
</div>
61+
62+
<div class="clearfix"></div>
63+
64+
<script src="http://znck.me/assets/js/app.js" type="text/javascript"></script>
65+
</body>
66+
</html>

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<li class="nav-item">
2+
<a class="nav-link" href="http://znck.me/">Home</a>
3+
</li>
4+
<li class="nav-item">
5+
<a class="nav-link" href="http://znck.me/blog">Blog</a>
6+
</li>
7+
<li class="nav-item">
8+
<a class="nav-link" href="http://sereno.in/projects">Projects</a>
9+
</li>
10+
<li class="nav-item">
11+
<a class="nav-link" href="https://github.com/znck" target="_blank">Github</a>
12+
</li>
13+
<li class="nav-item">
14+
<a class="nav-link" href="http://znck.me/about">About</a>
15+
</li>

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
dist/
2+
/.github/sereno/public
3+
/_cache
24
test/style.css
35
# Logs
46
logs/

‎README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ 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-
![Rollup Plugin for Vue](cover.png)
6+
> See [docs](http://znck.me/rollup-plugin-vue) for installing, using and contributing.
7+
8+
![Rollup Plugin for Vue](http://znck.me/rollup-plugin-vue/content/assets/images/cover.png)
79

810
<p align="center">
911
<a href="https://circleci.com/gh/znck/rollup-plugin-vue">
@@ -30,12 +32,6 @@ With rollup you can break your application into reusable modules.
3032
</a>
3133
</p>
3234

33-
## Installation
34-
[Node](http://nodejs.org/) and [Rollup](http://rollupjs.org) are required.
35-
```
36-
npm install --save-dev rollup-plugin-vue
37-
```
38-
3935
## Quick Start
4036

4137
Create project with vue-cli!
@@ -126,7 +122,7 @@ Use any option from [https://github.com/kangax/html-minifier](https://github.com
126122

127123
```js
128124
vue({
129-
htmlMinifier: {}
125+
htmlMinifier: {}
130126
})
131127
```
132128

‎circle.yml

+26-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
11
machine:
2-
node:
3-
version: 5.6.0
2+
php:
3+
version: 7.0.4
4+
5+
dependencies:
6+
pre:
7+
- curl -o- -s -L https://yarnpkg.com/install.sh | bash
8+
override:
9+
- mkdir -p build/logs
10+
- composer install --dev --no-interaction --no-progress
11+
- yarn --no-progress
12+
cache_directories:
13+
- "~/.yarn-cache"
14+
- "~/.composer/cache"
15+
16+
test:
17+
override:
18+
yarn test
19+
20+
deployment:
21+
publish:
22+
branch:
23+
- master
24+
- documentation
25+
commands:
26+
- composer global require --no-progress sereno/installer
27+
- sereno deploy

‎docs/advance.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Advanced Usage
2+
3+
> WIP
4+
5+
6+
-------------------------------
7+
[Edit this page on Github]({{ $docs_edit_url }}/configuration.md)

‎docs/changelog.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
All Notable changes to `rollup-plugin-vue` will be documented in this file.
4+
5+
## [Unreleased]
6+
7+
## [2.0.0]
8+
9+
### Added
10+
- Compile *.vue files.
11+
12+
[Unreleased]: https://github.com/znck/rollup-plugin-vue/compare/v2.0.0...HEAD
13+
[2.0.0]: https://github.com/znck/rollup-plugin-vue/compare/v1.0.3...v2.0.0

‎docs/conduct.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
* The use of sexualized language or imagery
10+
* Personal attacks
11+
* Trolling or insulting/derogatory comments
12+
* Public or private harassment
13+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
14+
* Other unethical or unprofessional conduct.
15+
16+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
17+
18+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community in a direct capacity. Personal views, beliefs and values of individuals do not necessarily reflect those of the organisation or affiliated individuals and organisations.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21+
22+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

‎docs/configuration.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Configuration
2+
3+
> WIP
4+
5+
6+
7+
8+
-------------------------------
9+
[Edit this page on Github]({{ $docs_edit_url }}/configuration.md)
10+
[Examples]({{ $docs_url }}/examples){.float-xs-right.pl-1}

‎docs/contributing.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/znck/rollup-plugin-vue).
6+
7+
8+
## Pull Requests
9+
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+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
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.
23+
24+
- **Tip** to pass lint tests easier use the `npm run lint:fix` command
25+
26+
27+
## Running Tests
28+
29+
Launch mocha wih the watch option with:
30+
31+
``` bash
32+
$ npm run dev
33+
```
34+
35+
36+
**Happy coding**!

‎docs/examples.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Examples
2+
3+
> WIP
4+
5+
6+
7+
-------------------------------
8+
[Edit this page on Github]({{ $docs_edit_url }}/configuration.md)
9+
[Advanced Usage]({{ $docs_url }}/advance){.float-xs-right.pl-1}

‎docs/index.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Prologue
2+
-------
3+
- [Introduction]({{ $docs_url}}/introduction)
4+
- [Github Repository]({{ $docs_repo }}){target=\_blank}
5+
- [Release Notes]({{ $docs_url }}/changelog)
6+
7+
Getting Started
8+
---------------
9+
- [Installation]({{ $docs_url }}/installation)
10+
- [Configuration]({{ $docs_url }}/configuration)
11+
- [Examples]({{ $docs_url }}/examples)
12+
- [Advanced Usage]({{ $docs_url }}/advance)
13+
14+
Community
15+
---------
16+
- [Issues & Questions]({{ $docs_issues }}){target=\_blank}
17+
- [Contribution Guide]({{ $docs_url }}/contributing)
18+
- [Code of Conduct]({{ $docs_url }}/conduct)
19+
- [License]({{ $docs_url }}/license)

‎docs/installation.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Installation
2+
[Node](http://nodejs.org/) and [Rollup](http://rollupjs.org) are required to use rollup-plugin-vue.
3+
4+
{#npm}
5+
### [](#npm) Using NPM
6+
```
7+
npm install --save-dev rollup-plugin-vue
8+
```
9+
10+
{#yarn}
11+
### [](#yarn) Using yarn
12+
```
13+
yarn add --dev rollup-plugin-vue
14+
```
15+
16+
17+
18+
-------------------------------
19+
[Edit this page on Github]({{ $docs_edit_url }}/configuration.md)
20+
[Configuration]({{ $docs_url }}/configuration){.float-xs-right.pl-1}

0 commit comments

Comments
 (0)