Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonnyjong/ezal

Blog framework
https://github.com/jonnyjong/ezal

Last synced: about 1 month ago
JSON representation

Blog framework

Awesome Lists containing this project

README

        

# Ezal
Simple blog framework.

[简体中文](https://github.com/JonnyJong/ezal/blob/main/readme.zh.md)

## Document
[English Document](https://github.com/JonnyJong/ezal/blob/main/docs/english.md)
[中文文档](https://github.com/JonnyJong/ezal/blob/main/docs/chinese.md)

## Todo
- [x] Markdown Renderer
- [x] Plugin System
- [ ] Typescript support (optional)
- [x] Remake category function
- [x] Improve server mode
- [x] Improve build process
- [x] Theme support
- [x] Document

## Use
Install Ezal.
```bash
npm init
npm install --save chokidar
npm install --save highlight.js
npm install --save live-server
npm install --save pug
npm install --save stylus
npm install --save yaml
npm install --save ezal
```

Add in `package.json`.
```json package.json
{
"scripts": {
"init": "node ./node_modules/ezal/dist/main.js init",
"build": "node ./node_modules/ezal/dist/main.js",
"serve": "node ./node_modules/ezal/dist/main.js serve",
"clean": "node ./node_modules/ezal/dist/main.js clean"
}
}
```

Init the project.
```bash
npm run init
```

Done.

## Build
```bash
npm install
npm install -g typescript
tsc
```

## Run
```bash
npm run serve
```

## Clean
```bash
npm run clean
```