An open API service indexing awesome lists of open source software.

https://github.com/codaea/obsidian-dimmed-dark


https://github.com/codaea/obsidian-dimmed-dark

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# GitHub Dimmed Dark Theme for Obsidian

A beautiful dark theme for Obsidian that brings GitHub's dimmed dark color palette to your notes. This theme uses the official color palette from [`@primer/primitives`](https://github.com/primer/primitives) to provide a familiar, GitHub-inspired experience.

![Theme Preview](https://github.com/user-attachments/assets/bddbb269-5d44-406e-9a1d-17a52ffea963)

## Features

- **Authentic GitHub Colors**: Uses the official GitHub dimmed dark color palette from Primer Design System
- **Comprehensive Coverage**: Styles all major Obsidian elements including:
- Text and headings
- Code blocks and syntax highlighting
- Links and tags
- Tables and lists
- UI elements (sidebar, status bar, modals)
- Canvas elements
- **Accessibility**: Designed with proper contrast ratios following GitHub's design principles
- **Plugin Compatibility**: Works well with popular plugins like Calendar, Kanban, and more

## Color Palette

The theme uses GitHub's dimmed dark color scheme:
- **Background**: Various shades of dark gray (#22272e, #2d333b, #1c2128)
- **Text**: Light gray (#adbac7) with muted variants
- **Accent**: GitHub blue (#539bf5)
- **Success**: Green (#57ab5a)
- **Warning**: Yellow/Orange (#c69026)
- **Danger**: Red (#f47067)
- **Purple**: #b083f0
- **Pink**: #e275ad

## Installation

### From Obsidian Community Themes (Recommended)
1. Open Obsidian Settings
2. Navigate to `Appearance` → `Themes`
3. Click `Browse` community themes
4. Search for "GitHub Dimmed Dark"
5. Click `Install and use`

### Manual Installation
1. Download the latest release from the [GitHub repository](https://github.com/Codaea/obsidian-dimmed-dark)
2. Extract the files to your vault's `.obsidian/themes/github-dimmed-dark/` folder
3. Restart Obsidian
4. Go to `Settings` → `Appearance` → `Themes` and select "GitHub Dimmed Dark"

## Development

This theme is built using:
- GitHub's official design tokens from `@primer/primitives`
- CSS custom properties for maintainability
- Comprehensive testing across Obsidian features

## Contributing

Contributions are welcome! Please feel free to:
- Report bugs or issues
- Suggest improvements
- Submit pull requests

## License

This theme is licensed under the MIT License. See [LICENSE](LICENSE) for details.

## Credits

- Colors based on [GitHub Primer Design System](https://primer.style/)
- Color tokens from [`@primer/primitives`](https://github.com/primer/primitives)
- Inspired by the official [GitHub VS Code theme](https://github.com/primer/github-vscode-theme)