Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 3.29 KB

README.md

File metadata and controls

96 lines (60 loc) · 3.29 KB

Obsidian GitHub Theme Fork

Promo

About this fork

Warning

This is my own personal fork! It's not in the store and has not been tested on mobile. Use at your own risk. (Well, whatever risk comes from a slightly wonky theme).

This fork adds some minor QoL improvements to the Obsidian plugin by krios2146:

  • Markdown elements, including block quotes, headers, and tags now match GitHub.com more closely
  • Focus states and other elements are less distracting
  • UI elements like nav rails, hotkey previews, primary buttons
  • All five GitHub Alert types now have matching colors and icons:
image

Roadmap

Major features on my radar:

image
  • Settings nav rail matches Primer Nav list
  • Callouts support GitHub's original syntax
  • Syntax highlighting matches the VS Code GitHub Theme more closely

Original README below

Preview

Screenshots

Screenshot-1

Screenshot-2

Screenshot-3

Kanban

Important

And that ain't no lie!

  • More drastic tweaks to Markdown and UI elements to match GitHub.com more closely
  • Other QoL tweaks to Obsidian base

All credit goes to GitHub and the Primer design system, and krios2146 for the plugin.

Features

  • Kanban board has been styled to look like a GitHub Project
  • Callouts in GitHub style
  • Inline code blocks in GitHub style
  • Obsidian UI buttons in GitHub style

Theme Settings

Theme settings can be find in the Style Settings plugin.

Current settings include:

  • Header colors
  • On/Off kanban styles
  • On/Off callout styles
  • Colorblind colorscheme variants

How to Install

Available on the Obsidian theme store.

Manually

  1. Download theme.css and manifest.json files from latest release
  2. Go to /your_vault/.obsidian/themes/ and create folder for theme files
  3. Paste downloaded theme files into created folder
  4. In Obsidian go to Settings -> Appearance -> select GitHub theme in dropdown menu

Contributing

Feel free to open issue or pull request on GitHub. I will be glad to work on it.