Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brandoncardoso/hima
A simple Jekyll theme with a focus on accessibility.
https://github.com/brandoncardoso/hima
a11y accessibility github-pages jekyll jekyll-theme theme
Last synced: about 1 month ago
JSON representation
A simple Jekyll theme with a focus on accessibility.
- Host: GitHub
- URL: https://github.com/brandoncardoso/hima
- Owner: brandoncardoso
- License: mit
- Created: 2022-12-05T12:42:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-14T16:31:31.000Z (over 1 year ago)
- Last Synced: 2024-10-09T10:35:45.430Z (about 1 month ago)
- Topics: a11y, accessibility, github-pages, jekyll, jekyll-theme, theme
- Language: SCSS
- Homepage: https://brandoncardoso.github.io/hima
- Size: 2.08 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# hima
hima is a simple Jekyll theme with the goal of being accessible to everyone, and follows [The A11Y Project's accessibility guidelines](https://www.a11yproject.com/checklist/).
[Theme Preview](https://brandoncardoso.github.io/hima)
## Installation
### Remote Theme Installation (for GitHub pages)
Add the following to your `Gemfile` to install the `jekyll-remote-theme` plugin:
```ruby
gem "jekyll-remote-theme"
```
Then in your `_config.yml`, set the theme, and add the plugin
```yaml
remote_theme: brandoncardoso/hima
plugins:
- jekyll-remote-theme
```
Finally run `bundle install` to install gems
### Gem-based Theme Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "hima"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: hima
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install hima
## Content
### Layouts
Refers to files within the `_layouts` directory, that define the markup for your theme.
- `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
- `home.html` — The layout for your landing-page / home-page / index-page. [[More Info.](#home-layout)]
- `page.html` — The layout for your documents that contain FrontMatter, but are not posts.
- `post.html` — The layout for your posts.
- `archive.html` — The layout for the category/tag archive page.
#### Home Layout
`home.html` is a flexible HTML layout for the site's landing-page / home-page / index-page. It will inject the content before the **Posts** heading. The posts list will only appear if you have at least one valid post, or draft with `show_drafts` enabled on your site.
##### Variables
* `post_list_title` (string) - overrides the post list title.
* `post_list_limit` (int) - limits the number of posts on the home page
### Includes
- `head.html` — Code-block that defines the `` in *default* layout.
- `custom-head.html` — Placeholder to allow users to add more metadata to `