https://github.com/mriiiron/salvia

A minimum-building static blog framework.
https://github.com/mriiiron/salvia

blog-engine javascript markdown plug-and-play static-site-generator

Last synced: 3 months ago
JSON representation

A minimum-building static blog framework.

• Host: GitHub
• URL: https://github.com/mriiiron/salvia
• Owner: mriiiron
• License: mit
• Created: 2018-02-01T21:56:58.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-08-16T16:08:07.000Z (about 4 years ago)
• Last Synced: 2024-04-12T22:13:34.475Z (7 months ago)
• Topics: blog-engine, javascript, markdown, plug-and-play, static-site-generator
• Language: JavaScript
• Homepage: http://mriiiron.github.io/salvia
• Size: 1.03 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - mriiiron/salvia - A minimum-building static blog framework. (JavaScript)

README

        
# SalviaJS

A fast and easy blog framework featuring minimum building. Only metadata of posts need to be built. Posts in Markdown would be parsed on-the-fly.

![Sage](./assets/sage.jpg)

## Features

- [WYSIWYG](https://en.wikipedia.org/wiki/WYSIWYG), and forget about the time you wasted while generating massive number of posts.

- Parser based on [CommonMark](https://github.com/commonmark/commonmark.js), with more features extended.

- Provided `salvia-cli` for easy blogging. [Get](https://github.com/mriiiron/salvia-cli)

## Quick Start

### Via npm (recommended)

Install CLI:

``` bash

$ npm install -g salvia-cli

```

Start your blog in "myblog" folder:

``` bash

$ salvia init myblog

```

You're all set.

### Manually

Follow [Full Guide](https://mriiiron.github.io/salvia) to set up proper folder structure and create your main page, post page, archive, page, etc.

In your page, link script:

``` html

```

Construct the container div:

``` html



```


And construct the blog into the container:

``` javascript

let blog = new Salvia({

    el: "#blog",

    main: {

        type: "feed",

        pagination: {

            limit: 5,

            page: Salvia.util.getUrlParamValue("page") || 1

        }

    },

    widgets: [

        {

            title: "TABLE OF CONTENTS",

            type: "recentPosts"

        },

        {

            title: "TAG CLOUD",

            type: "tagCloud"

        }

    ]

});

```

## To-do

- [x] SalviaFeed (with pagination)

- [x] SalviaPost

- [x] SalviaArchives

- [x] SalviaPostListWidget

- [ ] SalviaCategoryListWidget

- [x] SalviaTagCloudWidget

## License

MIT