Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boowajs/boowa
🚂 a fun blog generator
https://github.com/boowajs/boowa
Last synced: 1 day ago
JSON representation
🚂 a fun blog generator
- Host: GitHub
- URL: https://github.com/boowajs/boowa
- Owner: boowajs
- License: mit
- Created: 2018-02-18T08:45:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T08:00:24.000Z (over 4 years ago)
- Last Synced: 2024-08-02T19:38:03.521Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 244 KB
- Stars: 42
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-choo - boowa - A fun blog generator, built with `choo`. (Uncategorized / Uncategorized)
README
boowa
= a fun blog generator
**Table of Contents**
- [Themes](#themes)
- [Features](#features)
- [Quick Start](#quick-start)
- [Why my name is boowa](#why-my-name-is-boowa)
- [API](#api)
## Migrate
Because I lost my 2 factor authentic token, this project has moved to https://github.com/zhouhanseng/boowa
## Themes
Let's see some boowa blogs first, will add more themes later:
- [austere_theme](https://boowajs.github.io/austere_theme/)
- [classic_theme](https://boowajs.github.io/classic_theme/)
- [code_theme](https://boowajs.github.io/code_theme/)
## Features
- **colorful:** provide kinds of styles to take your fancy
- **simple:** few tips to play your blog
- **support offline:** keep reading even if there's no wifi
- **very modern:** works very well with async functions (node 7.6+)
- **fast as lightning:** it takes almost no time to generate a blog!
## Quick Start
1. Install boowa globally
```sh
npm install boowa -g
```
2. Make a directory to generate your blog
```sh
mkdir myBlog && cd myBlog
boowa
```
3. Select one style from the inquiring list
4) Start a development server
```sh
npm run start
```
## Why my name is boowa
boowa is built with:
- [bankai](https://github.com/choojs/bankai) - 🚉 - friendly web compiler
- [choo](https://choo.io/) - 🚂 4kb framework for creating sturdy frontend applications
- [awoo](https://github.com/awoojs/awoo) - 🔸 declarative small site generator
so, boowa
## API
### `boowa`
Generate a new blog app in a empty directory
### app structure
Actually a choo app yeah~, but you only need to handle markdown files and `_config.json`
### `boowa create`
Run this command to generate a new markdown file contains the necessary structure, and it will build the html file automatically:
⚠️ Put content in `markdown-body`:
### `_config.json`
This file contains metadatas like name, email etc.
### `boowa build`
After edit `_config.json` or modify markdown files, run this command to generate new templates.
### `npm run start`
Start a development server
### `npm run build`
Compile all files to dist/
### `boowa serve `
Boowa has a simple built-in server , after `npm run build && cd dist`, run this command to serve the production code.
### update the newest code
After install the newest boowa, run `boowa` in the boowa-existed directory, this update would not rewrite the markdown files and `_config.json`.
### support offline locally
Service-worker works under https in production mode, so if you want to test the offline function locally, for chrome, run this command first:
```sh
/Applications/Google\ Chrome.app/Conts/MacOS/Google\ Chrome --user-data-dir=/tmp/foo --ignore-certificate-errors --unsafely-treat-insecure-origin-as-secure=http://localhost:port
```
You will see `ServiceWorker registration successful with scope: http://localhost:port/` in the developer tool, if service-worker register successfully.
## License
[MIT](https://tldrlegal.com/license/mit-license)