Obsidian

<h1 align="center">Primary for <a href="https://obsidian.md">Obsidian</a></h1> <p align="center"> <a href="https://github.com/primary-theme/obsidian/stargazers"><img alt="Repo stars" src="https://img.shields.io/github/stars/primary-theme/obsidian?style=for-the-badge&logoColor=EEE7DD&labelColor=593E21&color=D6971B"></a> <a href="./LICENSE"><img alt="Repo License" src="https://img.shields.io/github/license/primary-theme/obsidian?style=for-the-badge&logoColor=EEE7DD&labelColor=593E21&color=BF3F35"></a> <a href=""><img alt="Repository Contributors" src="https://img.shields.io/github/contributors/primary-theme/obsidian?style=for-the-badge&logoColor=EEE7DD&labelColor=593E21&color=23739B"></a> </p> <p align="center" style="font-style: italic;"> Winner of <a href="http://obsidian.md/october2021">Obsidian October 2021</a>'s Best Theme ✨ <blockquote> Primary is soft, chewy, comforting — like a chocolate chip cookie, or a warm brownie. Primary instantly puts you in a relaxed state that opens the door to creativity and exploration. Wonderfully executed down to the smallest details, Primary ran away with first place. </blockquote> </p> <p align="right"> <strong>Obsidian October 2021 Judges</strong> </p> <small> This refresh wouldn't be possible without my <a href="https://github.com/primary-theme/obsidian/releases/tag/v.2.7.0">supporters</a>! <br><br> If you like the theme, consider supporting its development by making a one-time donation or subscribe monthly (with perks!) through <a href="https://ko-fi.com/ceciliamay">Ko-fi</a>. <br><br> Thank you so much for your patronage! <br><br> </small> <p align="center"> <a href='https://ko-fi.com/E1E76SQX8' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a> </p>

🧭 Navigation

• 🧭 Navigation
• 🖼️ Previews
  • Light Mode
    • Desktop
    • Tablet
    • Mobile
  • Dark Mode
    • Desktop
    • Tablet
    • Mobile
• 🍭 Design Approach
  • 🌞 Principles
    • Opinionated but Open
    • Functional Design
    • Balance of Aesthetic and Optimization
    • Top quality. Know you're in good hands.
    • A Collection of Fashion Houses
• 📖 Installation
  • Install Official Release
  • Install Beta Version
• 🧸 Features, Customization, and Plugins
• 🚧 Disclaimer
• 🌺 Contributing
  • Non-developers
  • Developers
    • Build Instructions
    • Setting up your Theme Dev Environment
    • Code, Build and Test
  • License
• 🧠 Creating Primary
• 🩵 Credits

🖼️ Previews

Light Mode

Desktop

Tablet

<p align="center"> <img alt="Primary for Obsidian on Tablet - Light Mode" src="https://github.com/primary-theme/obsidian/blob/main/assets/tablet-1_light-mode.png" width="768px"> </p>

Mobile

<p align="center"> <img alt="Primary for Obsidian on Tablet - Light Mode" src="https://github.com/primary-theme/obsidian/blob/main/assets/mobile-1_light-mode.png" width="320px"> </p>

Dark Mode

Desktop

Tablet

<p align="center"> <img alt="Primary for Obsidian on Tablet - Dark Mode" src="https://github.com/primary-theme/obsidian/blob/main/assets/tablet-1_dark-mode.png" width="768px"> </p>

Mobile

<p align="center"> <img alt="Primary for Obsidian on Tablet - Dark Mode" src="https://github.com/primary-theme/obsidian/blob/main/assets/mobile-1_dark-mode.png" width="320px"> </p>

🍭 Design Approach

Primary is an opinionated Obsidian theme that merges play with work.

Fine-tuned to pixel and color perfection, Primary aims to take away the need to think about customization, so that you can focus on what matters – the concepts, that link, this great idea.

Despite being opinionated, it has plenty of options and ways to make it yours.

Stay tuned, because Primary will come in more flavors soon.

🌞 Principles

Opinionated but Open

From high-level concept down to pixel-level perfection, we bring not only a theme, but an artistic experience.

Work doesn’t have to be boring, so we’re bringing play through Primary by putting you in interesting color environments.

A beautiful palette is to each their own, but we’re dedicated to allowing you to taste different versions of what we think is beautiful.

We made Primary to allow you to easily customize things on your own through snippets. Most of the code isn't hard coded, and the whole palette will be accessible through Style Settings.

Functional Design

• Primary forces you to focus on the files/note panes by lifting it up visually through dimming the sidebars
• Lower contrast/chroma for not so important things, and higher contrast/chroma to bring a sense of urgency.
• Layers (through visual cues of shadows, blur, and color) help establish different levels of the space
• Borders can easily garner attention due to the space they take (size, shape and color wise), but we added them with purpose: to either separate or lift

Balance of Aesthetic and Optimization

Primary is dedicated to serve bigger vaults. By following a design structure, it allows us to keep Primary’s code lean, lessening potential performance overhead while keeping its visual language.

This means sacrificing preset customizability. Most Primary users seem to use it out of the box, so we're putting out options in Style Settings for most customization use cases or special cases only.

Instead of presets, we exposed the variables, so that you're free to edit them to your liking. The caveat is that you do have to have some CSS knowledge, but rest assured we're here to explain as much as we can.

You will also be able to import Presets or create snippets, all using the exposed variables!

Top quality. Know you're in good hands.

Primary was built with every component's state in mind. Quality is considering the little things, that one may not know matters, but affects the overall experience.

We're here to build slow and deliberate, considering every pixel, fine tuning down to the decimals. Questions like: how does this thickness make me feel? What do these mix of colors trigger within me? We review the theme again and again every second you're immersed in it.

By giving you the best quality, we offload the stress of having to tinker to make Obsidian better by offering you a beautiful piece of product that just works.

A Collection of Fashion Houses

Primary isn’t here to give every single UI possibility. We’re here to give you just the Primary experience, but allow you to experience different fashion houses.

Additional color palettes and theme presets options will be available for those who want Primary’s design principles to better suit their personality.

📖 Installation

Install Official Release

This option will give you access to public releases.

1. Open up Obsidian and go to Settings.
2. Inside Settings, head over to the Appearance tab.
3. Under Themes, you should find a button called, Manage. Click on it. This will open up the Community Themes page.
4. On the search bar, type Primary, and click the one that says, By Cecilia May. It should open up the theme.
5. Click Install and Use to install the theme! Enjoy.

Install Beta Version

This option is exclusive to monthly subscribers of Primary.

1. Head on over to Primary's Ko-fi page.Under Buy a Coffee, choose Membership and subscribe to get access to member exclusive posts.
2. After subscribing, head over to the Posts tab. This is under the header, just below my name and ko-fi link.
3. Once in the Posts tab, you should be able to find posts usually titled along the lines of Primary x.x.x-beta (Monthly Subscriber Exclusive). Click on the latest post.
4. The post includes the full Release Notes so you're fully informed what new features or fixes you get for that release! To get the a copy of that beta, scroll down a bit until you find the Click here to download the CSS file. link. This should take you to a GitHub gist page.
5. On the GitHub gist page at the top right side, click Download Zip. This will give you a .zip file with 1 file inside, the primary-x.x.x-beta.css file (where x.x.x is the version number). 6