Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
tests
.babelrc
.editorconfig
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
blogium.png
bower.json
karma.config.js
package-lock.json
package.json
webpack.config.js

README.md

logo-Blogium Build Status

DEPRECATED: to use this, please refer to Blogium-Service/examples/vanilla

Install

  • as a script inclusion
<script src="./dist/blogium.js"></script>
  • as an npm package
yarn add blogium

or

npm i --save blogium
  • as a bower package
bower i --save blogium

Alternatively, you can always download a .zip file


Get started

After including the script anyway suited you best, just instantiate Blogium with the desired set of options

const blog = new Blogium(options);

Basic Usage

Blogium fires success and error event for the post request, you can listen to them:

blog.on('blogium.success', response => { console.info('I have posts!', response) });
blog.on('blogium.error',   response => { console.error('Oops, something has gone wrong', response) });

Options

host (string)

You can pass a string to what will be considered by Blogium your root host.

Default: document.location.host

targetBlank (boolean)

If you want to set all outbound links (not directed to your host) as _blank.

Default: true

username (string)

The Medium handler to fetch the RSS Feed from.

Default: @Medium

moreBtn (string)

id to the more vouchers button.

Default: #moreBtn

Wrapper (class)

class to the element(s) posts will be appended in.

Default: .mediumWrap

defaultTemplate (boolean)

Weather to use the default template to list the posts or handle the data by yourself

Default: true

postLimit (number)

Number of posts to be listed on each view. (infinite scroll is always on, posts are all cached on first request)

Default: 5

showCategories (boolean)

Show Medium categories for each post.

Default: true


MIT License - Atila Fassina

You can’t perform that action at this time.