Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sporeball/lifeblood

a hyperfocused Jekyll theme for documentation
https://github.com/sporeball/lifeblood

documentation github-pages jekyll jekyll-theme

Last synced: 3 months ago
JSON representation

a hyperfocused Jekyll theme for documentation

Awesome Lists containing this project

README

        

# lifeblood

**lifeblood** is a hyperfocused Jekyll theme for documentation - clean, customizable, cutesy.\
it's designed as the theme for [victus](https://sporeball.dev/victus)' documentation, while being available for all to use.

### quick start
if your site is hosted on GitHub Pages, you can add lifeblood to your site's `_config.yml` as a remote theme:

```yml
remote_theme: sporeball/lifeblood
```

#### gem-based theme
alternatively, you can install lifeblood as a gem-based theme.
1. add the gem to your `Gemfile`:
```ruby
gem "lifeblood"
```
2. change the `theme` parameter in your `_config.yml`:
```yaml
theme: lifeblood
```
3. use [Bundler](https://bundler.io)'s `bundle` command to update all bundled gems.

### usage
to see lifeblood in action, and for more information on usage and customization options, you can [view the documentation](https://sporeball.dev/lifeblood).

### donate
you can support the development of this project and others via Patreon:

[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dsporeball%26type%3Dpledges%26suffix%3D%252Fmonth&style=for-the-badge)](https://patreon.com/sporeball)