From 8a2b32dac2799f0b3ee3d391ebe9efa145b771c0 Mon Sep 17 00:00:00 2001 From: Mat Manna <91392083+matmanna@users.noreply.github.com> Date: Thu, 20 Nov 2025 17:18:10 +0000 Subject: [PATCH] :sparkles: Add better docs, styles --- README.md | 21 ++- _drafts/_pages/about.md | 186 ++++++++++------------- _drafts/_posts/2025-06-01-first.md | 16 +- _drafts/_posts/2025-06-02-second.md | 1 + _includes/nav.html | 27 ++-- _includes/toc-card.html | 224 +++++++++++++++++++++------- _layouts/default.html | 9 +- _layouts/page.html | 9 +- _layouts/post.html | 16 +- _layouts/project.html | 24 ++- _pages/about.md | 186 ++++++++++------------- _pages/blog.html | 19 ++- _pages/projects.html | 9 +- _posts/2025-06-01-first.md | 12 +- _posts/2025-06-02-second.md | 1 + assets/css/main.amber.css | 2 +- assets/css/main.blue.css | 2 +- assets/css/main.cyan.css | 2 +- assets/css/main.emerald.css | 2 +- assets/css/main.fuchsia.css | 2 +- assets/css/main.gray.css | 2 +- assets/css/main.green.css | 2 +- assets/css/main.indigo.css | 2 +- assets/css/main.lime.css | 2 +- assets/css/main.neutral.css | 2 +- assets/css/main.orange.css | 2 +- assets/css/main.pink.css | 2 +- assets/css/main.purple.css | 2 +- assets/css/main.red.css | 2 +- assets/css/main.rose.css | 2 +- assets/css/main.sky.css | 2 +- assets/css/main.slate.css | 2 +- assets/css/main.stone.css | 2 +- assets/css/main.teal.css | 2 +- assets/css/main.violet.css | 2 +- assets/css/main.yellow.css | 2 +- assets/css/main.zinc.css | 2 +- assets/css/tailwind.css | 20 +++ jekyll-theme-doctored.gemspec | 2 +- package.json | 3 +- 40 files changed, 479 insertions(+), 350 deletions(-) diff --git a/README.md b/README.md index 704ab2e..30ab811 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ A blog theme prioritizing uniqueness, technical complexity, and sophistication. 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! -**💫 Feature highlights:** +**💫 Features:** - 20+ color schemes & dark/light/system modes - Projects, blog, now, and contact pages @@ -31,10 +31,19 @@ Made using Jekyll and Tailwind following the [Tonic](https://tonic.hackclub.com) | ----- | ---- | | image | image | -## ⌨️ Usage +## 💾 Installation Instructions + +> [!NOTE] +> Additional installation/usage instructions are WIP + +To add to an existing Jekyll site using the packaged gem (recommended): -> [!IMPORTANT] -> Developing a site with doctored requires having Ruby, RubyGems, GCC, Make Bundle, Python, Node.js, and npm installed on your system. +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 @@ -42,9 +51,9 @@ Run `npm install` and `npm run dev` to develop. Run `npm run build` to build. Po ### 🖼️ 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!) +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. -Based on [@JacobU](https://github.com/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: +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:** diff --git a/_drafts/_pages/about.md b/_drafts/_pages/about.md index f0b5b8c..f7ceb03 100644 --- a/_drafts/_pages/about.md +++ b/_drafts/_pages/about.md @@ -1,116 +1,88 @@ --- layout: page title: About -description: Features of the Doctored Theme +description: What Doctored is and why it exists. footnotes: false toc: true --- -## Introduction - -> [!IMPORTANT] -> The Doctored theme is still very much a work-in-progress, so expect breaking features and lots of bugs! - ## Inspiration -The idea for doctored was taken from seeing so many amazing blogs which have their own distinctive, refined personalities. I wanted to combine these and make something sophisticated. - -## Features - -### markdown/post/page rendering: - -- Footnotes & Sidenotes -- GFM Admonitions -- Live, Floating, linked Table Of Contents -- Anchor links - -### site - -- UI modes and bold colorthemes - - Dark/light/system mode toggle and dropdown - - Customizable color themes (22 [colors](tailwindcss.com/docs/colors)!) -- Tailwind styling -- FontAwesome icons -- Scroll to top button -- Navbar and Footer -- Sticky header on posts -- Git site statistics -- RSS [feed]({{ '/feed.xml' | relative_url }}) -- [sitemap]({{ '/sitemap.xml' | relative_url }}) - -### pages - -- Homepage (index) -- About Page -- Post Pages -- Blog Page -- 404 Page -- Now Page -- Projects Page - -## Todo - -### new pages - -- Contact Form - -### post/page features: - -- Mermaid diagrams -- Dialogue chains -- Quote-ables -- expandable annotations -- Nice images with captions -- Code blocks (with origins) - - Syntax highlighting - - GitHub gists? - - Jekyll with Agda: https://github.com/paolobrasolin/jekyll-agda - -### site updates: - -- Webring & 88x31 section -- Post series (with pages) -- search -- page hover embeds -- microblog? -- backlinks -- FAQ section type -- Comments (giscus?) -- page network diagram - -### metadata stuff: - -- robots.txt -- update README/home/marketing - - add demo site links (under projects) - - technical product site (projects) ⚙️ - - the doctored documentation site!! - - individual portolio/blog 👋 - - digital garden 🪴 - - inspired by quartz for obsidian - - advertise "skins" better - - advertise the ability to "doctor"/customize/fudge/adjust/forge/alter/modify/tailor to specific needs - - adaptable/flexible - -### code/dx stuff: - - - Demo Video - - pnpm - - page section customizability through config - - cards/rows/etc similar to lualine syntax -- customization of small details - - icons (anchors, open in new) - - site fonts - - link formats - - secondary colors? - - status of - - footnote - - sidenote - - search - - TOC/moving TOC - - git metadata - - page progressbar - - nav - - tabs/language (blog/posts/updates/talks/notes/now/projects/contact/about) - - topbar vs sidebar -- GitHub-wiki-based documentation of all config options +The idea for doctored was taken from seeing so many amazing blogs which have their own distinctive, refined personalities. These include: + +- Alex Plescan's AMAZING hugo-based [blog](https://alexplescan.com/) +- Noel Berry's creative gamedev [page](https://noelberry.ca/index.html) +- Mahad Kalan's elegant astro [site](https://skyfall.dev/) +- the Quartz obsidian plugin theme +- the lualine neovim plugin +- and many more who I will make sure to acknowledge later! + +## Roadmap + +Doctored is very much still a WIP. Feel free to monitor or contribute to the status of the project! + +- #### rendering + - [x] footnotes & sidenotes + - [x] GFM (admonitions, checkboxes, etc.) + - [x] floating table of contents with links and scrollspy + - [x] heading anchors + - [ ] captioned images/figures + - [ ] quotes + - [ ] dialogue message chains + - [ ] codeblocks + - [ ] syntax highlighting + - [ ] linking w/ agda +- #### frontend + - [x] light/dark ui modes + - [x] responsive navbar/footer + - [x] fontawesome icons + - [x] git metadata (footer ref) + - [x] anchor/external link icons + - [ ] post tags + - [ ] project posts + - [ ] post series + - [ ] related posts + - [ ] post search (simple or advanced) + - [ ] link previews? + - [ ] page progressbars + - [ ] local time + - [ ] site map (graph) + - [ ] webrings + - [ ] 88x31s + - [ ] isso comments + - [ ] scroll to top button +- #### pages + - [x] index + - [x] about + - [x] blog + - [x] 404 + - [x] now + - [ ] stream microblog + - [x] projects + - [ ] tag + - [ ] contact +- #### meta + - [x] [sitemap]({{ '/sitemap.xml' | relative_url }}) + - [x] global RSS [feed]({{ '/feed.xml' | relative_url }}) + - [ ] tag rss feeds + - [ ] robots.txt +- #### docs + - [ ] demo/trailer video + - [ ] better README + - [ ] document doctored with doctored!! + - [ ] make starters for: + - [ ] digital gardening + - [ ] blogging + - [ ] portfolioing + - [ ] documenting +- #### dx + - [ ] rakefiles? + - [ ] nixos setup + - [ ] "doctor"ing with lualine-like config + - [ ] page sections + - [ ] FAQ + - [ ] foot + - [ ] navbar tabs + - [ ] style + - [ ] fonts + - [x] customizable tailwind palette (22 [colors](tailwindcss.com/docs/colors)!) diff --git a/_drafts/_posts/2025-06-01-first.md b/_drafts/_posts/2025-06-01-first.md index cae8abb..3f030d1 100644 --- a/_drafts/_posts/2025-06-01-first.md +++ b/_drafts/_posts/2025-06-01-first.md @@ -1,14 +1,22 @@ --- layout: post title: First Post -author: matmanna -description: The first post +authors: +- matmanna +- torvalds +description: I went to the event. It was a nightmare. footnotes: false +project: competition +mentions: + - title: Hacker News + icon: fa-brands fa-hacker-news + url: hackernews.com +tags: dev linux --- ## Introduction -### first - +### first11 +1 The very first post for the Doctored theme blog!this is a sidenote, an innovative way to insert extra information! ## Conclusion diff --git a/_drafts/_posts/2025-06-02-second.md b/_drafts/_posts/2025-06-02-second.md index c50d963..f599347 100644 --- a/_drafts/_posts/2025-06-02-second.md +++ b/_drafts/_posts/2025-06-02-second.md @@ -4,5 +4,6 @@ title: Second Post author: matmanna description: The first post footnotes: false +project: thesis --- The very second post for the Doctored theme blog! diff --git a/_includes/nav.html b/_includes/nav.html index f9fc4f9..8ca8699 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -1,18 +1,17 @@
{{site.data.nav.emoji}} -

{{ site.data.nav.title }}

 -
- + +

{{ site.data.nav.title }}

+ +
+ \ No newline at end of file diff --git a/_includes/toc-card.html b/_includes/toc-card.html index 4524cef..2c290ea 100644 --- a/_includes/toc-card.html +++ b/_includes/toc-card.html @@ -1,34 +1,140 @@ -
-
-
-

{{ page.title }}

- {% include toc.html html=content anchor_class="toc-link" %} -
- -