Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanshepps/jekyll-theme-minimal-ryan
Yet another minimalistic theme for Jekyll.
https://github.com/ryanshepps/jekyll-theme-minimal-ryan
jekyll jekyll-theme ruby-gem
Last synced: about 2 months ago
JSON representation
Yet another minimalistic theme for Jekyll.
- Host: GitHub
- URL: https://github.com/ryanshepps/jekyll-theme-minimal-ryan
- Owner: ryanshepps
- License: mit
- Created: 2022-12-18T20:48:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-23T12:29:00.000Z (over 1 year ago)
- Last Synced: 2024-04-24T17:42:31.623Z (9 months ago)
- Topics: jekyll, jekyll-theme, ruby-gem
- Language: SCSS
- Homepage: https://ryansheppard.tech
- Size: 3.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jekyll-theme-minimal-ryan
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyl-theme-minimal-ryan"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: minimal-ryan
```
And then execute:
```
bundle
```
This will install all dependencies.
## Usage
To test the theme locally, run
```
bundle exec jekyll serve
```
which will serve your site at [http://localhost:4000](http://localhost:4000).
### Customization
All customizable options can be configured in [_data/theme.yml](_data/theme.yml). Simply create your own data file and override the settings in [_data/theme.yml](_data/theme.yml).
### Adding a Blog Home
The theme provides you with a blog home that can display all the posts in the _posts folder. Simple create a file at the root directory and give it the `blog` layout in the front matter.
### Customizing the Header
Whenever you create a new page (with any layout) at the root directory, the theme will add an entry to the header. If you want the name of the entry to be different from the file, add a title to the front matter of the page. This title will show up on the header instead.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ryanshepps/jekyll-theme-minimal-ryan.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Acknowledgements
- Syntax highlighting for `` blocks comes from https://github.com/jwarby/jekyll-pygments-themes.