๐ŸŽฉ Doctored

Gem Version License: MIT wakatime GitHub Actions Workflow Status

A blog theme prioritizing uniqueness, technical complexity, and sophistication.

๐Ÿงช Demo Deployment: https://matmanna.github.io/doctored

๐ŸŒŸ Overview

Made using Jekyll and Tailwind following the Tonic starter guide and template. No other jekyll theme really felt like it matched what I would have wanted so I created my own!

๐Ÿ’ซ Feature highlights:

  • 20+ color schemes & dark/light/system modes
  • Projects, blog, now, and contact pages
  • GFM support (tables, admonitions, etc.)
  • Git metadata access
  • Floating Table of Contents
  • Side & foot notes
  • RSS feed & sitemap
  • Responsive nav, footer sections

๐Ÿ“ธ Demo Images:

image image
image image

โŒจ๏ธ Usage

[!IMPORTANT] Developing a site with doctored requires having Ruby, RubyGems, GCC, Make Bundle, Python, Node.js, and npm installed on your system.

โ–ถ๏ธ Running

Run npm install and npm run dev to develop. Run npm run build to build. Postinstall and other scripts have been configured to use bundle install, bundle exec jekyll serve --watch, and bundle exec jekyll build respectively.

๐Ÿ–ผ๏ธ Formatting posts

To post a new post, run npm run post markdown_file_path_in__drafts, which formats it with side/foot notes then moves it to _posts/ (or root if page!)

Based on @JacobU's postMarkdown python script, doctored supports writing your posts/pages in a simple markdown file within _drafts before running the post script to format it in the following ways:

  • Foot/sidenotes:

To add a foot/side note, include the following in your draft markdown:

  <small>Richly-formatted (html) content of note</small>

๐Ÿ™Œ Contributing

Please create Issues and PRs for bugs/feature requests and updated code respectively.

๐Ÿ“œ License

Doctored is licensed under the MIT, which means you can do (almost) anything with it!!