From 4fcdd0c3f5267689938904daacc25b3dfb694fbc Mon Sep 17 00:00:00 2001 From: Mat M Date: Thu, 6 Aug 2026 18:12:44 -0400 Subject: [PATCH] chore: read(ability)me --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 30ab811..0235aac 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ A blog theme prioritizing uniqueness, technical complexity, and sophistication. -**๐Ÿงช Demo Deployment:** https://matmanna.github.io/doctored +**Demo Deployment:** https://matmanna.github.io/doctored -## ๐ŸŒŸ Overview +## Overview Made using Jekyll and Tailwind following the [Tonic](https://tonic.hackclub.com) starter guide and [template](https://github.com/hackclub/tonic-starter). No other jekyll theme really felt like it matched what I would have wanted so I created my own! -**๐Ÿ’ซ Features:** +**Features:** - 20+ color schemes & dark/light/system modes - Projects, blog, now, and contact pages @@ -25,13 +25,13 @@ Made using Jekyll and Tailwind following the [Tonic](https://tonic.hackclub.com) - RSS feed & sitemap - Responsive nav, footer sections -## ๐Ÿ“ธ Demo Images: +## Demo Images: | image | image | | ----- | ---- | | image | image | -## ๐Ÿ’พ Installation Instructions +## Installation Instructions > [!NOTE] > Additional installation/usage instructions are WIP @@ -43,13 +43,13 @@ To add to an existing Jekyll site using the packaged gem (recommended): 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 +## Usage -### โ–ถ๏ธ Running +### 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 +### 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. @@ -62,10 +62,10 @@ To post a new post, run `python utils/postMarkdown.py _drafts/_posts/example-001 Richly-formatted (html) content of note ``` -## ๐Ÿ™Œ Contributing +## Contributing Please create Issues and PRs for bugs/feature requests and updated code respectively. -### ๐Ÿ“œ License +### License Doctored is licensed under the MIT, which means you can do (almost) anything with it!! -- 2.51.2