Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jdanielmourao/obsidian-sanctum
A minimalist theme for Obsidian.md, with the aim of creating a serene space of retreat, for thought and uninterrupted work.
https://github.com/jdanielmourao/obsidian-sanctum
dark-mode light-mode obsidian-community obsidian-md obsidian-theme theme
Last synced: about 1 month ago
JSON representation
A minimalist theme for Obsidian.md, with the aim of creating a serene space of retreat, for thought and uninterrupted work.
- Host: GitHub
- URL: https://github.com/jdanielmourao/obsidian-sanctum
- Owner: jdanielmourao
- License: mit
- Created: 2021-10-07T14:26:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T11:35:13.000Z (3 months ago)
- Last Synced: 2024-09-26T20:44:18.286Z (about 2 months ago)
- Topics: dark-mode, light-mode, obsidian-community, obsidian-md, obsidian-theme, theme
- Language: CSS
- Homepage:
- Size: 17.5 MB
- Stars: 313
- Watchers: 9
- Forks: 22
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## Sanctum 1.0 for Obsidian 0.16
### Disclaimer for Sanctum Users
- The sidenote syntax has changed (they are now callouts. Example: `>[!aside|left]` will give a left aligned callout. If you want to make it go further left, you can add up to 5 `+` next to the `left` information (for example: `>[!aside|left +++++]` will push the sidenote to the margin, so it doesn't mess with text);
- Images work similarly to asides, but they also get a `-` syntax, as well as sizing options (`-xs`, `-s`, `-m`, `-l`(regular size), `-xl`, `xxl`, as well as a `center`/`centre` option;
- Custom checkboxes have been expanded: `*`,`a`,`f`,`S`,`-`,`>`,`<`,`l`,`B`,`X`,`n`,`p`,`c`,`w`,`b`,`I`,`!`,`?`,`i`,`/`,`u`,`d`,`F`,`r`,`m`,`M`,`L`,`t`,`T`,`P`. They should mostly match the one's in Primary;
- there are TONS of new style settings options, and more to come;
- Work on the UI is at its beginning stages. The theme has been completely rewritten from scratch (no exaggeration there), so expect regular changes in the foreseeable future!
Sanctum’s a minimalist theme for creating a serene space of retreat, for thought and uninterrupted work.
## Installation
Inside obsidian, go to `Settings ➞ Appearance ➞ Manage`, and look for `Sanctum`.
You can also manually install Sanctum by:
1. Downloading the CSS file and moving it into the folder `.obsidian/themes/` located in your vault folder;
2. Rename the css file to `Sanctum.css`;
3. In Obsidian, go to `Settings ➞ Appearance ➞ Themes ➞ Reload themes`, and select `Sanctum`.
## Disclaimer
The following theme significantly alters Obsidian's original css, and so is prone to breaking upon new Obsidian updates, as well as being incompatible with custom css snippets, which might require specific adjustments.
## Recommended Plugins
- [Smart Typography](https://github.com/mgmeyers/obsidian-smart-typography): for a better and coherent writing experience
- [Contextual Typography](https://github.com/mgmeyers/obsidian-contextual-typography): For a better typographic experience, and access to some of the theme's features
- [Style Settings](https://github.com/mgmeyers/obsidian-style-settings): for tons of customization options
## Design Principles
**Intentional**
- This theme was made with the intent of clarifying Obsidian's UI, reducing the unnecessary clutter and keeping what's essential for an enjoyable and intuitive experience;
- Greyscale palette is the same both for light as well as dark theme;
- Colour is also used for contrast when hovering and activating elements.
**Consistent**
- Every element is styled according to a predetermined grid, scale, animations (based on IBM's Carbon Design System) and colours - this conveys consistency throughout the theme;
- The theme was created with the intention of using only one workhorse font family, used everywhere, but styled differently. Thus the theme comes with only 1 font family - IBM Plex
- Offer a similar enjoyable experience, independently of screen size or device.
**Clean**
- Use of calming colours, only used either to convey importance, or in the note file itself;
- The background colour is the same in every element, to reduce visual noise and give a more calming atmosphere;
- Elements are related to each other using the rules of visual *gestalt*. This means that they're grouped by proximity, in a common region or as a focal point.
## Showcase (outdated)
###### Preview Mode
###### Edit Mode
###### Modal
###### Prompt
###### Resize Handles
- Resize Handles are understated, until hovered.
## Features
- Custom icons (as well as custom file icons!);
- Sidenotes (credit @SlRvb);
- Multi-Color Highlights (credit @Atlas);
- Custom Checkbox / Task types, and Pseudo Admonitions;
- Custom Codeblock language - `pure-text`, that enables you to write text for easy copying;
- Image desaturation: better for consistency, they gain normal colour when hovered (credit @kepano);
- Active line highlighting;
(for a more comprehensive walkthrough of Sanctum's features, check out the [Theme Guide](documentation/Theme_Guide.md))
## Plugin Support
- Advanced Tables
- Block Reference Counter
- Breadcrumbs
- Calendar
- Changelogs
- Charts
- Checklist
- Copy Code Button (it now supports Obsidian v0.12.17's new code copy button!)
- Dataview
- Excalidraw
- Gallery
- Kanban
- Quick Explorer
- Sliding Panes (Andy’s Mode)
- Style Settings
- Templater
(for plugin support requests & issues, refer to Feedback & Contributions)
## Feedback & Contributions
If you encounter an issue, or would like to contribute to this theme, don't hesitate to submit an issue or raise a PR. You can also message me on [Discord](https://discord.com/invite/veuWUTm) @jdaniel or on the [Obsidian Forums](https://forum.obsidian.md/u/jdanielmourao/summary).
## Support
If you enjoy my work and would like to support it, you may click the icons below, or the links on the right side of this repository.
[](https://ko-fi.com/X8X56R5Q1)