mirror of
https://github.com/vuejs/awesome-vue.git
synced 2025-02-10 15:34:40 -05:00
Amend doc following revamp
This commit is contained in:
parent
bd6a9fde01
commit
5480f3497d
2 changed files with 24 additions and 13 deletions
|
@ -1,5 +1,18 @@
|
|||
# Contributing Guide
|
||||
|
||||
1. Make sure you put things in the right category!
|
||||
2. Always add your items to the end of a list. To be fair, the order is first-come-first-serve.
|
||||
3. If you think something belongs in the wrong category, or think there needs to be a new category, feel free to edit things too.
|
||||
To add another awesome resource, simply create a `.md` file under an appropriate directory in `/awesomeness` with these contents:
|
||||
|
||||
``` yaml
|
||||
---
|
||||
name: Your Project Name
|
||||
url: http://yourproject.io
|
||||
author: "Your Name (http://yourhomepage.net)"
|
||||
description: "[Markdown](https://daringfireball.net/projects/markdown/) is supported!"
|
||||
tags:
|
||||
- pure
|
||||
- awesomess
|
||||
```
|
||||
|
||||
The only mandatory information is `name`, though obviously, you're encouraged to fill in as much information as you can!
|
||||
|
||||
Note: Since the `.md` file actually uses YAML syntax and is parsed by a YAML parser, you'll need quotes if your content includes special characters, e.g. `:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `\`. Or, to play it safe, just quote all the things™!
|
||||
|
|
18
README.md
18
README.md
|
@ -1,18 +1,16 @@
|
|||
# awesome-vue
|
||||
|
||||
> A curated list of awesome things related to Vue.js
|
||||
A curated list of awesome things related to Vue.js. Inspired by [HTML5 Please](https://github.com/h5bp/html5please/). See the site in action [here](https://awesome.vuejs.org).
|
||||
|
||||
## Build Setup
|
||||
|
||||
``` bash
|
||||
# install dependencies
|
||||
npm install
|
||||
Here you go:
|
||||
|
||||
# serve with hot reload at localhost:8080
|
||||
npm run dev
|
||||
* `npm install` to install dependencies
|
||||
* `npm run dev` to serve the dev version with hot reload at localhost:8080
|
||||
* `npm run build` to build for production with minification
|
||||
* `npm run parse` to parse the awesome resources into a JSON data file
|
||||
|
||||
# build for production with minification
|
||||
npm run build
|
||||
```
|
||||
## License
|
||||
|
||||
For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).
|
||||
MIT
|
||||
|
|
Loading…
Add table
Reference in a new issue