Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/carols12352/oreo-theme

The Oreo theme of obsidian
https://github.com/carols12352/oreo-theme

obsidian obsidian-md obsidian-theme themes

Last synced: 2 months ago
JSON representation

The Oreo theme of obsidian

Host: GitHub
URL: https://github.com/carols12352/oreo-theme
Owner: carols12352
License: gpl-3.0
Created: 2024-07-17T00:30:50.000Z (5 months ago)
Default Branch: master
Last Pushed: 2024-07-25T01:54:08.000Z (5 months ago)
Last Synced: 2024-10-14T07:22:39.820Z (2 months ago)
Topics: obsidian, obsidian-md, obsidian-theme, themes
Language: CSS
Homepage:
Size: 1.09 MB
Stars: 6
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  
Oreo Obsidian Theme


  


    Welcome to the Oreo Obsidian Theme! This theme brings the classic and delicious colors of Oreo cookies to your Obsidian experience. With both dark and light modes available, you can enjoy a visually pleasing interface whether you're a fan of the dark chocolate cookie or the creamy filling.

    


    The author creates this theme to memorize the good time back in primary school and the nickname Oreo.

    


    Report bug

    ·

    Request feature

  


  


    

      

    

    

      

    

    

      

    

	

      

	

  

  

  

    English

    ·

    简体中文

  


## Table of contents

- [Features](#features)

- [Installation](#installation)

- [Customization](#customization)

  - [General Variables](#general-variables)

  - [Dark Mode Specific Variables](#dark-mode-specific-variables)

  - [Light Mode Specific Variables](#light-mode-specific-variables)

- [Author](#author)

- [Screen shots](#screen-shots)

- [Unique Features](#unique-features)

- [Contributing](#contributing)

- [Bugs and reports](#bugs-and-reports)

- [License](#license)

## Features

* **Dark Mode** : Black and dark gray colors with white text, inspired by the Oreo cookie.

* **Light Mode** : White and light gray colors with black text, inspired by the Oreo cream filling.

* **Custom Icons and Navigation** : Enhanced iconography and navigation styling for a cohesive look.

## Installation

To install the Oreo theme in Obsidian, follow these steps:

1. **Download the theme** :

* Theme will be available for download in Obsidian app, or download the whole Oreo file and place it in themes file which is seen on [Help theme](https://help.obsidian.md/Extending+Obsidian/Themes).

1. **Copy files to Obsidian themes folder** :

* Place `manifest.json` and `theme.css` into your Obsidian themes directory. The directory can be found at `VaultFolder/.obsidian/themes/`.

1. **Activate the theme** :

* Open Obsidian, go to `Settings` > `Appearance` > `Themes`.

* Find "Oreo" in the list of available themes and activate it.

## Customization

The Oreo theme comes with a variety of customization options available through plugin [style settings](https://github.com/mgmeyers/obsidian-style-settings) and we provide a lot of customization options, users can try to make a contribution by upload your personal configuration file.

### How to upload a customization

* Fork this repo

* Put your file [here](./plugins/Style-Settings)

* Click here to open a pull request

* Wait for the admin to test and approve your json file

## Author

This theme was created by [carols12352](https://github.com/carols12352).

## Screen shots



## Unique features

### Check box

Thanks to [@kepano](https://github.com/kepano/obsidian-minimal) and [@colineckert](https://github.com/colineckert/obsidian-things), we have custom check-boxes.



  

  



`- [ ] Default Checkbox`

`- [!] Important Task`

`- [*] Star Task`

`- [-] Strikethrough Task`

`- [<] Pending Task`

`- [>] Completed Task`

`- [I] Information Task`

`- [b] Bookmark Task`

`- [c] Critical Task`

`- [d] Declined Task`

`- [f] Failed Task`

`- [k] Key Task`

`- [l] Location Task`

`- [p] Progress Task`

`- [u] Upvoted Task`

`- [w] Watched Task`

`- [P] Open Pull Request Task`

`- [M] Merged Pull Request Task`

`- [D] Draft Pull Request Task`

`- ["] Quoted Task`

`- [“] Quoted Task (Double Quote)`

`- [?] Question Task`

`- [/] Slash Task`

`- [S] Success Task`

### Tab styles

Thanks to [AnubisNekhet](https://github.com/AnubisNekhet/AnuPpuccin), we can have custom tab bars(note that this is still a experimental feature, no promise for full function on devices other than windows and IOS, IpadOS), users can enable it using [style settings](https://github.com/mgmeyers/obsidian-style-settings) plugin, by navigating to `plugin-style settings` - `oreo theme` - `experimental features` - `tab style` then you can enjoy the brand new tab styles!

## Contributing

If you'd like to contribute to the Oreo theme, feel free to fork the repository and submit a pull request on [GitHub](https://github.com/carols12352/Oreo-theme).

## Bugs and reports

If you experience a bug or you want to leave feedback, feel free to contact us at [email protected], we will respond to you ASAP!

## License

This theme is licensed under the GNU GPL 3.0 License. See the `LICENSE` file for more information.

Enjoy your new deliciously themed Obsidian experience!