krios2146_obsidian-theme-github/README.md

# Obsidian GitHub Theme

![Promo](/imgs/promo.png)
![](https://img.shields.io/badge/downloads-54200%2B-7ee787?style=for-the-badge&labelColor=21262d)
[![](https://img.shields.io/badge/Obsidian%20October%202022-Runner%20Up-7b6cd9?style=for-the-badge&logo=obsidian&labelColor=21262d)](https://obsidian.md/blog/2022-obsidian-october-winners/#New%20theme)

## Preview

<details>
<summary> Screenshots </summary>
<p>

![Screenshot-1](/imgs/screenshots/note.png)

![Screenshot-2](/imgs/screenshots/note-2.png)

![Screenshot-3](/imgs/screenshots/command-palette.png)

![Kanban](/imgs/screenshots/kanban-plugin.png)

</p>
</details>

## Features

- [Kanban](https://github.com/obsidian-community/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 find in the [Style Settings](https://github.com/obsidian-community/obsidian-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.

<details>
<summary> Manually </summary>
<p>

1. Download `theme.css` and `manifest.json` files from latest [release](https://github.com/krios2146/obsidian-github/releases/)
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 -> Themes -> select GitHub Theme in dropdown menu

</p>
</details>

## Contributing

Feel free to open [issue](https://github.com/krios2146/obsidian-github/issues) or [pull request](https://github.com/krios2146/obsidian-github/pulls) on GitHub. I will be glad to work on it.