Skip to content

matmanna/doctored

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

137 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽฉ 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!

๐Ÿ’ซ 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:

image image
image image

๐Ÿ’พ Installation Instructions

Note

Additional installation/usage instructions are WIP

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

About

๐ŸŽฉ A jekyll theme prioritizing uniqueness, complexity, and sophistication.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors

Languages