mirror of
https://github.com/scottkirvan/GitHubDHC.git
synced 2026-07-22 03:30:29 +00:00
83 lines
5 KiB
Markdown
83 lines
5 KiB
Markdown
<div align="center">
|
||
<img src="https://github.com/ScottKirvan/GitHubDHC/blob/master/imgs/promo.png?raw=true" alt="promo" height="auto" />
|
||
<h1><a href="https://github.com/ScottKirvan/GitHubDHC">GitHubDHC</a></h1>
|
||
<h3>A GitHub Dark High Contrast theme for Obsidian!</h3>
|
||
|
||
<!-- Badges -->
|
||
<p>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/graphs/contributors">
|
||
<img src="https://img.shields.io/github/contributors/ScottKirvan/GitHubDHC" alt="contributors" />
|
||
</a>
|
||
<a href="">
|
||
<img src="https://img.shields.io/github/last-commit/ScottKirvan/GitHubDHC" alt="last update" />
|
||
</a>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/network/members">
|
||
<img src="https://img.shields.io/github/forks/ScottKirvan/GitHubDHC" alt="forks" />
|
||
</a>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/stargazers">
|
||
<img src="https://img.shields.io/github/stars/ScottKirvan/GitHubDHC" alt="stars" />
|
||
</a>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/issues/">
|
||
<img src="https://img.shields.io/github/issues/ScottKirvan/GitHubDHC" alt="open issues" />
|
||
</a>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/blob/master/LICENSE">
|
||
<img src="https://img.shields.io/github/license/ScottKirvan/GitHubDHC.svg" alt="license" />
|
||
</a>
|
||
</p>
|
||
|
||
<h4>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/issues/">Report Bug</a>
|
||
<span> · </span>
|
||
<a href="https://github.com/ScottKirvan/GitHubDHC/issues/">Request Feature</a>
|
||
</h4>
|
||
</div>
|
||
|
||
I do a lot of writing in Markdown, mostly for things that I'm doing up on [GitHub](https://github.com/). ([Obsidian](https://obsidian.md/) is an great editor for this). I was running into some frustration with the formatting not mapping really well between Obsidian and GitHub, when I thought, "there has to be a theme for this!" I found [@krios2146's](https://github.com/krios2146) awesome [Obsidian GIthub Theme](https://github.com/krios2146/obsidian-theme-github).
|
||
|
||
It was close, but not really the way *my* GitHub looks (I use the GitHub Dark High Contrast theme when I'm working online), so I decided to start hacking the css a bit to see how close I could get. The look of GitHubDHC is different enough from the original theme that I decided to start a new fork based on Vladimir's really nicely done Obsidian GitHub Theme -- it's worth checking out - he did all the initial work and the Kanban theme'ing - it's really good.
|
||
|
||
I'm not a css creator and I'm sure I've used some poor practices and there's probably some bugs in here (editing modes can get funky!) - but enjoy - I've been using it a ton lately and I'm really finding it difficult going back to the more normal Obsidian themes now. I started with Vladimir's css, comparing it to GitHub's own DHC css (`ctrl-shift-i`), and have relied on several other themes to help me understand how themes work in obsidian.
|
||
|
||
This theme DOES NOT support Obsidian's light color scheme, and I'm not sure if any of the Vladimir's original colorblind colorschemes are still working or not. I welcome the help from anyone that wants to work on this stuff, plus, GitHub uses a lot of fun style tricks in their page rendering that would be cool to see implemented.
|
||
|
||
## Features
|
||
- [Kanban](https://github.com/mgmeyers/obsidian-kanban) board has been styled to look like a GitHub Projects
|
||
- Callouts in GitHub style
|
||
- Inline code blocks in GitHub style
|
||
- Obsidian UI buttons in GitHub style
|
||
|
||
## Theme Settings
|
||
Theme settings can be found in the [Style Settings](https://github.com/mgmeyers/obsidian-style-settings) plugin.
|
||
|
||
Current settings include:
|
||
- Header colors
|
||
- On/Off kanban styles
|
||
- On/Off callout styles
|
||
- Colorblind colorscheme variants
|
||
|
||
## How to Install
|
||
I hope to have it available soon on the Obsidian theme store.
|
||
|
||
### Manual Install
|
||
1. Download and unzip (or clone) this repo into your vault's `/.obsidian/themes` directory (if that directly doesn't exist yet, create it)
|
||
2. Open **Settings** in *Obsidian*
|
||
3. Navigate tothe **Appearances** tab under **Options**
|
||
4. Under the **Themes** section, click on the dropdown menu next to the **Theme** heading and select `GitHubDHC`
|
||
5. Click the reset button for the **Accent color**, and set your preferred **Zoom level**.
|
||
6. That's it! You're set up - Enjoy!
|
||
|
||
## Contributing
|
||
For any bugs or ideas for new features, please submit a [New Issue](https://github.com/ScottKirvan/GitHubDHC/issues) . The best way to contribute directly is to make the changes yourself and submit them as a [New Pull Request](https://github.com/ScottKirvan/GitHubDHC/pulls). Thank you!
|
||
|
||
## Credits
|
||
A huge thank you and all creds due to [@krios2146](https://github.com/krios2146) and his [Obsidian GitHub Theme](https://github.com/krios2146/obsidian-theme-github).
|
||
|
||
Vladimir Kidyaev (2022-2023)
|
||
Scott Kirvan (2023)
|
||
|
||
## Contact
|
||
Feel free to reach out to me on the [Obsidian Members Group (OMG)](https://discord.gg/obsidianmd) Discord server - I'm @cptvideo
|
||
|
||
Project Link: https://github.com/ScottKirvan/GitHubDHC
|
||
If you're writing markdown, and not using *Obsidian*, check it out: https://obsidian.md/
|
||
|