https://github.com/sporeball/lifeblood
a hyperfocused Jekyll theme for documentation
https://github.com/sporeball/lifeblood
documentation github-pages jekyll jekyll-theme
Last synced: 8 months ago
JSON representation
a hyperfocused Jekyll theme for documentation
- Host: GitHub
- URL: https://github.com/sporeball/lifeblood
- Owner: sporeball
- License: mit
- Created: 2021-04-04T19:22:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-17T16:45:54.000Z (over 4 years ago)
- Last Synced: 2025-02-01T02:22:55.819Z (over 1 year ago)
- Topics: documentation, github-pages, jekyll, jekyll-theme
- Language: HTML
- Homepage: https://sporeball.dev/lifeblood
- Size: 118 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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:
[](https://patreon.com/sporeball)