Render changelog as a website on the fly.
Clone or download
Latest commit 52ec661 Oct 8, 2017
Permalink
Failed to load latest commit information.
changelog update html file Jul 27, 2017
config init Jul 27, 2017
example init Jul 27, 2017
src tweak text color Jul 27, 2017
static fix deps Oct 8, 2017
.editorconfig init Jul 27, 2017
.gitattributes init Jul 27, 2017
.gitignore init Jul 27, 2017
CHANGELOG.md Update CHANGELOG.md Sep 15, 2017
LICENSE init Jul 27, 2017
README.md export vue component Jul 27, 2017
circle.yml init Jul 27, 2017
package.json fix deps Oct 8, 2017
yarn.lock fix deps Oct 8, 2017

README.md

LogLive

This is inspired by headwayapp.co but as a single script you can add to an HTML file.

preview

NPM version NPM downloads CircleCI donate

Install

yarn add loglive

Table of Contents

Usage

You can simply create an index.html and include loglive there:

<html>
<head>
  <title>App Title</title>
  <link rel="stylesheet" href="https://unpkg.com/loglive/dist/loglive.css">
</head>
<body>
  <div id="app"></div>
  <script src="https://unpkg.com/loglive"></script>
  <script>
    new LogLive({
      el: '#app'
    })
    // And that's it!
  </script>
</body>
</html>

Then you can start to write a CHANGELOG.md, by default LogLive will read from http://your-website/CHANGELOG.md, however you can use a custom path:

new LogLive({
  el: '#app',
  changelog: '/path/to/my-changelog.md'
})
You can also use it as a Vue component
<template>
  <div id="app">
    <log-live 
      changelog="changelog">
    </log-live>
  </div>
</template>

<script>
import { LogLive } from 'loglive'

export default {
  components: {
    LogLive
  },

  data() {
    return {
      changelog: '/changelog.md'
    }
  }
}
</script>

Changelog Format

Example

# My Website

## Add TypeScript support (2016-07-23)

### New

- Now added Typescript support.
- Some other new stuffs.

### Fix

Fixed some babel problems.

Site name

The value of h1 heading will be used as website name:

# My Website

Changelog Title

Changelog title is an h2 heading which consists of two parts, title and date and date is totally optional.

## changelog title (date)

Sometime you just want to use semantic version as the changelog title:

## 1.3.0 (2015-02-43)

Change Type

Change type is an h3 heading which describes the type of the change, eg: Fix. And it shows up like:

change type

By default we have pre-defined colors for specific types which include: Fix Breaking New, other types will get a random color.

You can also set color for custom change type:

new LogLive({
  colors: {
    'Bug fixes': '#342343'
  }
})

Front Matters

website

You changelog is born for your product, so adding a link to your actual product is necessary:

---
website: http://my-fantastic-app.com
---

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

loglive © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

egoist.moe · GitHub @egoist · Twitter @_egoistlily