Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ellekasai/shiori
[Unmaintained] A Bootstrap-based Jekyll Theme.
https://github.com/ellekasai/shiori
Last synced: 18 days ago
JSON representation
[Unmaintained] A Bootstrap-based Jekyll Theme.
- Host: GitHub
- URL: https://github.com/ellekasai/shiori
- Owner: ellekasai
- Created: 2014-09-07T05:49:29.000Z (about 10 years ago)
- Default Branch: gh-pages
- Last Pushed: 2022-01-20T18:31:32.000Z (almost 3 years ago)
- Last Synced: 2024-08-01T00:45:17.119Z (3 months ago)
- Language: HTML
- Homepage: http://ellekasai.github.io/shiori
- Size: 193 KB
- Stars: 323
- Watchers: 14
- Forks: 131
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Unfortunately, this project is **no longer maintained**.
I now have other priorities in my life and no longer have time to update this library. Email me at [email protected] if you'd like to reach me.
# :ribbon: Hi! I'm Shiori, a Bootstrap-based Jekyll Theme. :ribbon:
## :ribbon: Live Demo :ribbon:
### [You can view the live demo of myself here](http://ellekasai.github.io/shiori).
## :ribbon: Screenshots :ribbon:
### Desktop/Tablet
## :ribbon: Color Schemes :ribbon:
I wear different colors (based on [Flat UI Colors](http://flatuicolors.com/)).
- Dark
- Turquoise
- Green
- Blue
- Purple
- Orange
- Red
## :ribbon: Usage :ribbon:
**Note:** If you're not familiar with Jekyll, please read up on [Jekyll's documentation](http://jekyllrb.com/) first.
[Fork this repo](http://github.com/ellekasai/shiori/fork), clone it, and then run:
```
bundle install
```
...which installs `github-pages` gem. After that, run the server:
```
jekyll serve --watch
```
### :warning: Warning :warning:
Once the server is started, you must go to [http://localhost:4000/shiori/](http://localhost:4000/shiori/), since `baseurl` is set as `"/shiori"` initially.
To use http://localhost:4000/, change `baseurl` in `_config.yml` to `""` .
### Keeping Shiori Up to Date
To keep Shiori up to date, follow these steps:
1. [Configure a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork)
2. [Sync a fork](https://help.github.com/articles/syncing-a-fork) (**Note**: Use `gh-pages` instead of `master`.)
## :ribbon: Customization :ribbon:
### Required
You **should** change these files before deploying:
* `_config.yml`: You must change `baseurl`, `url`, and `title`. Others are optional.
* Make sure to restart the server after you update `_config.yml`.
* `CNAME`: Change this to host Shiori on a custom domain.
* `README.md`: Write your own README!
* `_includes/nav.html`: Modify or remove navigation links.
* `_includes/nav-right.html`: Modify or remove navigation links.
* `_includes/sidebar.html`: Customize the side bar.
* `_includes/post-header.html`: Customize the post header.
* `_includes/post-footer.html`: Customize the post footer.
* `_includes/footer.html`: Add copyright info, etc.
### Optional
You **may** customize these files - they're optional:
* `favicon.ico`: Favicon.
* `about.html`: About page. Currently not linked from anywhere.
* `_includes/head.html`: Extra stuff in the `` tag.
* `_includes/scripts.html`: Extra stuff before the `` tag.
* `_includes/post-header-home.html`: Customize the post header on the home page.
### Customize the Theme
To change my color theme, edit `_data/theme.yml`.
### Add Your Own CSS
You can customize CSS by editing these files:
* `_sass/custom-bootstrap-variables.scss`: Change Bootstrap variables ([documentation](http://getbootstrap.com/customize)).
* `_sass/custom-scss.scss`: Add your own custom CSS.
### Category Pages
If you want to make category pages, you must manually push the generated `_site` directory to GitHub. If you're still okay with that, [@alextsui05](https://github.com/alextsui05) made an [excellent demo and tutorial for category pages](http://alextsui05.github.io/shiori/categories-in-shiori/). You can see his code on [this pull request](https://github.com/ellekasai/shiori/pull/11).
## :ribbon: Author :ribbon:
#### Elle Kasai
* http://github.com/ellekasai
#### Special Thanks
* [Shu Uesugi](http://github.com/chibicode) - for the guidance on this project.
### License
[MIT License](http://ellekasai.mit-license.org/)