article-editor

An assistant for bloggers without blog services

Usage no npm install needed!

<script type="module">
  import articleEditor from 'https://cdn.skypack.dev/article-editor';
</script>

README

Article Editor

Build Status

An assistant for bloggers without blog services

Languages

Description

You could publish articles without a lot of inconvenience if you used "Article Editor".

Features

  • Generate any articles with a template
  • Manage a list of article ids
  • Run smoothly

Requirement

How to Use

Some folders will be generated for the first time.

  1. Edit template/index.html(template).
    Special variables are available in the template.

    • ${title} ... Article's title
    • ${createdAt} ... Article's date
    • ${content} ... Article's content

  2. Execute npm start to launch.

  3. View http://localhost:8005 after running.

  4. Feel free to create your articles following instructions!

Installation

Execute these commands.

$ git clone https://github.com/GenbuHase/ArticleEditor.git
$ cd ArticleEditor
$ npm install

Config

system/config.js is editable.

{
    PORT: An used port(Number),

    PATH: {
        ARTICLE: A directory, containing a collection of articles(String),
        PUBLISH: A directory, containing generated html of articles(String),
        MEDIA: A directory, containing medias of each articles(String),
        COMMONMEDIA: A directory, containing common medias(String),
        TEMPLATE: A directory, containing a template(String)
    },

    onCreate: A callback, called when any articles are created(Function),
    onDelete: A callback, called when any articles are deleted(Function),
    onSave: A callback, called when any articles are drafted(Function),
    onPublish: A callback, called when any pages are generated(Function),
    onUpload: A callback, called when any medias are uploaded(Function)
}

Author

License

MIT License