Skip to content

subframe7536/obsidian-theme-maple

Repository files navigation

Important

Maple Theme 1.0 is currently in beta state. While it is already suitable for normal use, it is not yet stable and may contain bugs. Please feel free to report any issues you encounter. You can checkout the old version here.

Maple

GitHub stars License: MIT Style Settings

A sleek and modern Obsidian theme for desktop and mobile, featuring awesome components, graceful animation and customizable preferences via the Style Settings plugin. It embeds the self-designed monospace font Maple Mono.

Screenshot

Or support me through Afdian (PayPal)

Note: Backward compatibility is not guaranteed due to time constraints.

Quick Start

Install

  1. Open Obsidian and navigate to Settings > Appearance.
  2. Click Manage to open the Community Themes store.
  3. Search for "Maple" in the filter box.
  4. Click Install and Enable.

Manually

  1. Download the source code zip (Click to download).
  2. Extract the files to <your-vault>/.obsidian/themes/maple/ (Ensure the theme.css and manifest.json are in the maple/ folder).
  3. Restart Obsidian.

Customize (Recommended) ✨

Enhance your experience with the Style Settings community plugin:

  1. Go to Settings > Options > Community plugins
  2. Ensure community plugins option is turning on, then click Browse button.
  3. Search for "Style Settings" and install it.
  4. Enable the plugin.
  5. In Settings > Community plugins > Style Settings, you'll find Maple's style options.

Features

Maple offers a highly customizable experience with extensive options via Style Settings. Below is a summary of key features, grouped by category.

Your Flavor Matters

Maple is designed to be highly customizable, allowing you to tailor the theme to your liking. You can change the color scheme, layout, app background, and more.

Layout Style Settings

Enhance the Experience

Maple includes awesome components and graceful animations throughout—tab switches, hovers, modals, editor, tree list and scrollbars—for a fluid workflow.

Main Page Showcase

Plenty of new icons are designed to promote the visual experience. Also, Maple has first-class support of Alternate Checkbox.

Icon Showcase

Syntax Description
- [ ] To-do
- [/] Incomplete
- [x] Done
- [-] Canceled
- [>] Forwarded
- [<] Scheduling
- [?] Question
- [!] Important
- [*] Star
- ["] Quote
- [l] Location
- [b] Bookmark
- [i] Information
- [S] Dollar
- [I] Idea
- [p] Pros
- [c] Cons
- [w] Win
- [u] Up
- [d] Down
- [+] Add
- [B] Bug
- [a] Alarm
- [n] Note
- [R] Review
- [L] Love

Optimized for Mobile

Maple is optimized for Obsidian on mobile devices, ensuring a seamless experience across different screen sizes. But everything just getting started, I will keep working on it.

Mobile Showcase

Development

Please ensure Bun (better Node.js) is installed.

# Install deps
bun i

# Dev and hot reload
bun run dev

# Build product
bun run build

# Release
bun run release

Fonts, svgs are located at resource/ and icons come from iconify-json packages. They will auto load at compile time. See usage in src/custom-functions.ts

Style settings config is auto generated by the script, see compile.ts and src/style-settings/

Credits

Inspired by:

Enhance your DX with my plugin: Obsidian DevTools Font and Scrollbar

License

MIT License

About

[1.0 Beta] Obsidian theme for desktop with graceful animation and awesome components

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published