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@example.com if you'd like to reach me.
I wear different colors (based on Flat UI Colors).
Note: If you're not familiar with Jekyll, please read up on Jekyll's documentation first.
Fork this repo, clone it, and then run:
github-pages gem. After that, run the server:
jekyll serve --watch
Once the server is started, you must go to http://localhost:4000/shiori/, since
baseurl is set as
To use http://localhost:4000/, change
To keep Shiori up to date, follow these steps:
You should change these files before deploying:
_config.yml: You must change
title. Others are optional.
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.
You may customize these files - they're optional:
about.html: About page. Currently not linked from anywhere.
_includes/head.html: Extra stuff in the
_includes/scripts.html: Extra stuff before the
_includes/post-header-home.html: Customize the post header on the home page.
To change my color theme, edit
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.
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.