generated from obsidianmd/obsidian-sample-theme
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0563c6b
commit 16234a5
Showing
2 changed files
with
21 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,28 @@ | ||
# Apex Obsidian Theme | ||
|
||
This is a simple, distraction free theme for the powerful writing app [Obsidian](https://www.obsidian.md). Me and [Vignesh](https://twitter.com/c_m_vignesh) built this as a passion project over a weekend. It currently works best on macOS, but we will fix up any issues and publish updates to support other platforms too. | ||
![](./docs/cover.png) | ||
|
||
## TODOs | ||
A simple, distraction free theme for [Obsidian](https://www.obsidian.md), crafted by [Sid](https://www.sid.me) and [Vignesh](https://twitter.com/c_m_vignesh) for folks who: | ||
|
||
- [ ] Finalize and bundle the fonts within the theme | ||
- [ ] Improve colours in fullscreen mode | ||
- [ ] Check theme on Windows and Linux | ||
- [ ] Replace some characters with alternate glyphs | ||
1. prefer simpler things | ||
2. love monospaced type | ||
3. use hotkeys to navigate | ||
|
||
If you're comfortable with Vim keybinds, you can absolutely fly through the UI and type away at the speed of thought! It currently works best on macOS but if you run into issues on your platform, please raise them with us and we'd love to help. | ||
|
||
## Issues / Feature Requests | ||
|
||
This [Github repo](https://www.github.com/clearlysid/apex) is the best place to raise something to us. Alternatively, you can send an email to **[email protected]**. | ||
|
||
## Development Guide | ||
|
||
1. Clone this repo | ||
2. Remove the `.example` from the `.env.example` and provide the path to your Obsidian vault | ||
3. Run `npm i` to install all dependencies | ||
4. Run `npm start` to "watch" all `src/*.css` files and compile the theme with hot reloads. | ||
|
||
## Acknowledgements | ||
|
||
- [Obsidian Sample Theme](https://github.com/obsidianmd/obsidian-sample-theme) as a starting point. | ||
- [Minimal Theme](https://github.com/kepano/obsidian-minimal?tab=readme-ov-file) repo for the CSS build process. | ||
- [Geist and Geist Mono](https://vercel.com/font) by Vercel. A beautiful family of open-source fonts. | ||
- We used the [Obsidian Sample Theme](https://github.com/obsidianmd/obsidian-sample-theme) as a starting point. | ||
- The CSS build process is based on [Minimal Theme](https://github.com/kepano/obsidian-minimal). | ||
- Typeset in the beautiful [Geist and Geist Mono](https://vercel.com/font) by Vercel. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.