🎩 Doctored #

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!

💫 Features:

• 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: #

💾 Installation Instructions #

To add to an existing Jekyll site using the packaged gem (recommended):

1. add the gem "jekyll-theme-doctored dependency to your Gemfile
2. run bundle install
3. add theme: jekyll-theme-doctored to your Jekyll _config.yml
4. follow the usage instructions below to serve (or continue customizing) your site!

⌨️ Usage #

▶️ 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 #

If you want to use sidenotes in your posts/pages, begin by copying the utils/postMarkdown.py script and creating a _drafts directory within your project.

To post a new post, run python utils/postMarkdown.py _drafts/_posts/example-001.md, which will format and copy it to _posts/ (or root if page!)

• 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!!