<p align="center">
<img src="https://cdn.rawgit.com/egoist/fde30f7f3eae29d66b52736367f0267c/raw/95fe77f4401a2df004094d7ef8d1e3d93de98480/peco.svg" alt="temp logo, are you a designer? you can help! Peco deserves a better logo :D" width="500"></p>

<p align="center"><a href="https://npmjs.com/package/peco"><img src="https://img.shields.io/npm/v/peco.svg?style=for-the-badge" alt="NPM version"></a> <a href="https://npmjs.com/package/peco"><img src="https://img.shields.io/npm/dm/peco.svg?style=for-the-badge" alt="NPM downloads"></a> <br><a href="https://circleci.com/gh/egojump/peco"><img src="https://img.shields.io/circleci/project/egojump/peco/master.svg?style=for-the-badge" alt="Build Status"></a> <a href="./BACKERS.md"><img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&amp;style=for-the-badge" alt="donate"></a> <a href="https://spectrum.chat/peco"><img src="https://img.shields.io/badge/chat-on%20spectrum-7b16ff.svg?style=for-the-badge" alt="chat"></a> <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge"></a></p>


## What is this?

Peco is a static website generator powered by modern web tooling, like webpack and Vue.js. It generates static HTML files and assets at build time, once the generated website is loaded on the client-side, it runs as an SPA.

## How is it?

It is good. I don't think I'll ever use Hexo again.

## Installation

It's recommended to install peco locally in your project:

```bash
cd your-project
yarn add peco
```

## How to use?

Let me explain how to use it in 20 words:

- `source/*.md` is your pages
- `source/_posts/*.md` is your posts
- `peco dev [directory]` to run it
- `peco build [directory]` to build it

For details please check out the [docs](./docs).

[Documentation website is work-in-progress](https://github.com/egojump/peco/issues/23).

## Build with Peco

- [EGOIST's blog](https://egoist.moe) ([source](https://github.com/egoist/blog))
- Add yours? PR welcome!

## Contribute?

Find bugs, spread the words, share your ideas.

```bash
yarn
yarn example
```

---

<img src="https://cdn.rawgit.com/egoist/abf92e5f6adfa4cbb47651c1cdb3630d/raw/8c2b6488e353c2b6ca79cce4b15f0f43493aedb6/egojump.svg" alt="egojump">
