https://github.com/634750802/bloxciting
Bloxciting is an simple exciting blog system.
https://github.com/634750802/bloxciting
Last synced: 3 months ago
JSON representation
Bloxciting is an simple exciting blog system.
- Host: GitHub
- URL: https://github.com/634750802/bloxciting
- Owner: 634750802
- Created: 2018-04-14T18:42:37.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-18T13:19:46.000Z (about 7 years ago)
- Last Synced: 2024-10-18T16:26:02.875Z (8 months ago)
- Language: JavaScript
- Size: 227 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Bloxciting
> Bloxciting is an simple exciting blog system.
Bloxciting serves markdown file as blog and directory as category.
It will watch file changes and update etag for caching.
It use client-rendering to display blog content.
## Usage
Write config file `bloxciting.config.json`.
```bash
npm i bloxciting
```
```js
// index.js
const bloxciting = require('bloxciting')
bloxciting.serveAssets()
bloxciting.serveHomePage()
bloxciting.setLoggerLevel('trace')
bloxciting.start()
```
Then you can write blogs in markdown.
See /example
## Config File
```js
// bloxciting.config.json
{
"app": {
"blog-home": "blog-home", // This is the home dir of blog files.
"port": 18888 // bloxciting will start a koa service listening this port, default is 18888.
},
"author": {
"nickname": "D·Jagger",
"email": "[email protected]",
"signature": "Front-end developer, feeling excited in Vue.js and all great front end projects."
}
}
```
## API
. | .
- | :-
Method | GET
URL | /api/v1/blogs/path/to/blogOrCategory
Returns | String, Object
Description | If returns string, the content is blog content(in html). Otherwise, the content is a category object.