Planning Document

Design and Development Planning Document

oliver is a jekyll theme designed for personal websites and blogs.

Mock-ups

Design Ideas

• Color scheme inspired by solarized light but with black/dark text.
• Small text
• High information density

Design Inspiration

• https://jcs.org/
• https://push.cx/
• https://xeiaso.net/blog/
• https://ben.page/
• https://tontinton.com/
• https://taylor.town/

Technical

• Jekyll Theme
  • Should be installable as gem-based theme
  • Should be 100% compatible with github pages
• CSS Styling
  • Vanilla CSS?
  • Tailwind? https://tailwindcss.com/
    • DaisyUI? https://daisyui.com/

Misc Requirements

• Add ability to pin certain blog posts to the top of the blog post list
• Add ability to put a small bio/text blob above the list of blog posts on the main page
• Page types
  • page
  • post (blog)
  • list/collection (A special page type for lists of things, reviews, etc)
• First class support for code blocks.
  • See: https://github.com/rouge-ruby/rouge, https://kramdown.gettalong.org/syntax_highlighter/rouge.html
• Archive page for a list of all blog posts
• Configure how many posts to show in the list on the main page (but by default, no limit...or at least a sensible LARGE limit).

Resources

• https://jekyllrb.com/docs/themes/
  • https://jekyllrb.com/docs/themes/#creating-a-gem-based-theme
• Default Jekyll theme: https://github.com/jekyll/minima
• Theme development example: https://www.youtube.com/watch?v=UuHrgv6p2Mg