/peco

A static website generator for humans (beta)

Primary LanguageJavaScriptMIT LicenseMIT

temp logo, are you a designer? you can help! Peco deserves a better logo :D

NPM version NPM downloads
Build Status donate chat

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:

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.

Documentation website is work-in-progress.

Build with Peco

Contribute?

Find bugs, spread the words, share your ideas.

yarn
yarn example

egojump