Code Monkey home page Code Monkey logo

bloxciting's Introduction

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.

npm i bloxciting
// 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

// 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.

bloxciting's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.