Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upash/peco
nothing here, move on..
https://github.com/upash/peco
blog ssg static-site static-site-generator vue webpack
Last synced: 3 months ago
JSON representation
nothing here, move on..
- Host: GitHub
- URL: https://github.com/upash/peco
- Owner: upash
- License: mit
- Archived: true
- Created: 2018-04-25T07:10:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-30T03:03:11.000Z (about 6 years ago)
- Last Synced: 2024-06-21T06:40:51.796Z (7 months ago)
- Topics: blog, ssg, static-site, static-site-generator, vue, webpack
- Language: JavaScript
- Homepage:
- Size: 362 KB
- Stars: 209
- Watchers: 11
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Peco is no longer maintained 💀, check out its successor, [Saber](https://github.com/egoist/saber) 🔥!
[![npm version](https://badgen.net/npm/v/peco)](https://npmjs.com/peco) [![circleci](https://badgen.net/circleci/github/uchudenpa/peco/master)](https://circleci.com/gh/uchudenpa/peco) ![status](https://badgen.net/badge/status/beta/pink)
## Introduction
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.
Check out the [documentation](https://peco.upa.sh) for details.
## 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## 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
```