Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benjaminwil/lifer

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/benjaminwil/lifer
Owner: benjaminwil
Created: 2022-07-21T02:20:58.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-30T03:01:16.000Z (2 months ago)
Last Synced: 2024-10-30T06:12:23.136Z (2 months ago)
Language: Ruby
Size: 283 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Lifer

Lifer is an extensible static site generator. Out of the box, it provides a

classic static site generation experience, complete with RSS feed and ERB

templating. Unlike other Ruby-based static site generators, Lifer encourages you

to bring your own asset pipeline and configure it as a pre-build step.

_Lifer is currently in pre-release. Features are incomplete. Your mileage may

vary._

## Features

Here's a short overview of Lifer's flagship features.

### Bring your own asset pipeline

Whether you want to compile assets with Ruby-based tools, JavaScript-based

tools, or other tools, Lifer is okay with that. As long as those tools come with

a commandline interface, Lifer can shell out to those tools as a prebuild step.

### Collections and selections

If you have multiple collections of entries that must be output in different

ways, Lifer can help you do this. While every entry can only belong to a single

collection, you can create your own "selections" filter to group entries across

collections.

### Extensibility

Lifer autoloads any Ruby files included in the root of your project

automatically. This lets you specify your own custom output builders, feed

formats, and meta-collections of entries.

### Development server

Need to preview your static site before your build it on your production server?

No problem. Just use the Lifer commandline interface to start a development

server at `http://localhost:9292`:

    $ lifer serve

## Installation

_This installation guide assumes you already have Ruby 3 installed on your

system._

I recommend installing Lifer via Bundler. In the root directory of your static

site source, add a Gemfile if one doesn't exist already:

    $ bundle init

In the Gemfile, add the `lifer` gem:

```ruby

gem "lifer", "<= 1"

```

And then execute:

    $ bundle install

## Development

_This development guide assumes you already have Ruby 3 installed on your

system._

Clone this repository, install dependencies via Bundler, and ensure the test

suite can run on your machine:

    $ git clone https://github.com/benjaminwil/lifer lifer

    $ cd lifer

    $ bundle install

    $ bundle exec rspec

## Contributing

_TODO_