Skip to content
This repository has been archived by the owner on Aug 15, 2023. It is now read-only.

Commit

Permalink
docs: 📝 Update for 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
selfire1 committed Feb 23, 2022
1 parent 10d5ef6 commit 552bf3d
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 11 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
## [1.0.0](https://github.com/selfire1/obsidian-you-theme/releases/tag/1.0.0) (2022-02-23)
### ✨ NEW
- Rewrite theme into SCSS
- Apply Material 3 Typography
- Implement Material 3 Colour Scheme
- Add styling for plugins (breadcrumbs, cooklang)
- Redesign elements like buttons, metadata container and FAB
- Add option for a custom Floating Action Button
- Style Obsidian Live Preview

### Deletions
- 🔥 Remove custom colours. In the future, adaptive colour schemes will be added through a plugin.

## [0.1.7](https://github.com/selfire1/obsidian-you-theme/releases/tag/0.1.7) (2021-12-04)
### Improvements
- style: 💄 Lighten page header buttons
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
# Obsidian You 🎨
![Obsidian You Overview](https://github.com/selfire1/obsidian-you-theme/blob/main/images/colours.png?raw=true)
![Obsidian You Overview](https://github.com/selfire1/obsidian-you-theme/blob/main/theme-picker.png?raw=true)

**Take Obsidian on the go, your way.** A theme exclusively designed for mobile.

*Obsidian You was written during [Obsidian October 2021](https://forum.obsidian.md/t/obsidian-october-2021-make-plugins-and-themes-together-and-win-awards/24471).*

> ✅ Status: Available in Obsidian's Community themes.
✅ Available in Obsidian's Community themes.

## Goals
* Reflecting Google's [Material Design Guidelines](https://m3.material.io/) to feel native on Android, and beautiful anywhere else. ✨

## Features
### Dynamic Colour
<img src="https://i.imgflip.com/5s1qsg.jpg" width="250" />
### Tonal colour palettes & Adaptive type scale
<img src="https://github.com/selfire1/obsidian-you-theme/blob/main/images/colour-typo.png?raw=true" width="500" />

Pick your favourite colour ([*Illuminating*](https://www.pantone.com/color-of-the-year-2021) anyone?). From this source colour a custom pallette gets automatically generated for you. Dynamic colour makes Obsidian personal while not overwhelming with options. You can pick your colour through the plugin [Style Settings](https://github.com/mgmeyers/obsidian-style-settings).
Obsidian You is based on Google's [Colour System](https://m3.material.io/styles/color/the-color-system/) and [Typography](https://m3.material.io/styles/typography/overview). Carefully generated colour palettes make Obsidian beautiful, consistent and accessible. Light or dark mode alike. The M3 type scale makes sure all your text is styled consistently.

### Floating Action Button
<img src="https://github.com/selfire1/obsidian-you-theme/blob/main/images/floating-action-button.png?raw=true" width="500" />

Skip the thumb-stretching and switch from preview to edit mode right at your fingertips. Shades of dynamic colour quickly indicate which mode you are in.
Skip the thumb-stretching. You can even customise the FAB command to your liking. Install the [Customizable Page Header Buttons](https://github.com/kometenstaub/customizable-page-header-buttons) plugin. The first custom button will be the FAB command. Have every command of Obsidian right at your fingertips! (And you can even pick a pretty icon)

### Dark Mode
<img src="https://github.com/selfire1/obsidian-you-theme/blob/main/images/dark-mode.png?raw=true" width="500" />

Reduce eye strain and save battery while you're up all night connecting. Your custom colour pallette automatically adapts to dark mode. For easy switching between modes on mobile, have a look at [Luna: Dark Mode Switcher](https://github.com/selfire1/obsidian-luna-dark-mode).
Reduce eye strain and save battery while you're up all night connecting. The tonal colour pallette automatically adapts to dark mode. For easy switching between modes on mobile, have a look at [Luna: Dark Mode Switcher](https://github.com/selfire1/obsidian-luna-dark-mode).

## Supported plugins
* [Style Settings](https://github.com/mgmeyers/obsidian-style-settings): Customise colour, fonts and additional settings.
* [Obsidian Advanced Toolbar](https://github.com/phibr0/obsidian-advanced-toolbar): Activate in *Style Settings*.
* [Customizable Page Header Buttons](https://github.com/kometenstaub/customizable-page-header-buttons): Customise the FAB
* [Breadcrumbs](https://github.com/SkepticMystic/breadcrumbs)
* [Cooklang Obsidian](https://github.com/deathau/cooklang-obsidian)

## Additional tools
* 🌝 [Luna – Dark Mode Helper](https://github.com/selfire1/obsidian-luna-dark-mode): An Obsidian Plugin that switches into Dark Mode based on time or sun position,supporting Mobile.
Expand All @@ -37,8 +38,7 @@ Reduce eye strain and save battery while you're up all night connecting. Your cu

## Acknowledgements
* Thank you to [mgmeyers](https://github.com/mgmeyers) for providing valuable and detailed feedback,
* thank you to `@daggers` for a huge annotated image dump using the theme on tablet,
* thank you to `@Eleanor` for test-driving this theme.
* thank you to `@Eleanor` and `@daggers` for test-driving this theme.

## Support
You can help me keep creating tools like this by [buying me a coffee](https://www.buymeacoffee.com/joschua). ☕️
Expand Down
Binary file removed images/001.png
Binary file not shown.
Binary file added images/colour-typo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/colours.png
Binary file not shown.
Binary file modified images/dark-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/floating-action-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified theme-picker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 552bf3d

@tyler-chase
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using this but can't seem to find the settings button anymore. How do I access it?

Please sign in to comment.