shiori
shiori copied to clipboard
ellekasai
[Unmaintained] A Bootstrap-based Jekyll Theme.
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.
:ribbon: Screenshots :ribbon:
Desktop/Tablet
:ribbon: Color Schemes :ribbon:
I wear different colors (based on Flat UI Colors).
- 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 first.
Fork this repo, 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/, 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:
- Configure a remote for a fork
-
Sync a fork (Note: Use
gh-pagesinstead ofmaster.)
:ribbon: Customization :ribbon:
Required
You should change these files before deploying:
-
_config.yml: You must changebaseurl,url, andtitle. Others are optional.- Make sure to restart the server after you update
_config.yml.
- Make sure to restart the server after you update
-
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<head>tag. -
_includes/scripts.html: Extra stuff before the</body>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). -
_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 made an excellent demo and tutorial for category pages. You can see his code on this pull request.
:ribbon: Author :ribbon:
Elle Kasai
- http://github.com/ellekasai
Special Thanks
- Shu Uesugi - for the guidance on this project.
ellekasai