Front End Party! Obsidian Micro-Hack

--> https://obsidian.md/download <--

Obsidian API Docs

• API Home
  • App Class

Quickstart

• Plugin Getting-Started

---

Workflow!

To Start!

• 📌Clone down this repo
  • 📍Remember where you clone it
• 📌Navigate into the obsidian-micro-hack directory
• 📌Cut your team a branch from main:
  • 📍git checkout -b your-teams-branch
• 📌Navigate into the src subdirectory
• 📌Install dependencies with npm
  • 📍npm i

Develop & Test!

• ⭐IMPORTANT!! Download and extract this vault.zip in the root of obsidian-micro-hack
• 📌Launch Obsidian, press ctrl + p, type "vault", select "open another vault"
• 📌Click the "Open folder as vault" Open button
  • 📍Navigate to where you cloned the repo and select the subdirectory called "vault"

Sandbox!

• 📌In Obsidian, ctrl + p
• 📌Type "settings" and press enter
  • 📍Or just press ctrl + ,
• 📌Select "Community plugins" in the left side nav pane
• 📌Turn on community plugins
  • 📍You may need to press "Turn on and reload"
  • 📍If you do not see "Copy Image Shortcut" in your "Installed plugins" click on "Reload plugins" on the right

Develop!

• 📌Compile back in your terminal inside src
  • 📍npm run dev (this will include Hot Module Reload)

To Submit!

• 📌git push origin your-teams-branch
• 📌Navigate to GitHub and open a PR to main PR to main must be open by 7:15pm CT sharp!

Helpful Tips!

• Open Obsidian Dev Tools (like browser dev tools): ctrl + shift + i in Windows and Linux, or cmd - option - i on macOS.
• Open Obsidian Command Palette: ctrl + p
• Obsidian Development Hot-Reload Plugin
• The current version of Obsidian (as of 01/06/25) is 1.7.7 to be used with your versions.json if you include one

---

Scoring Criteria

Points	Category
10	Cleanliness
10	Brevity
10	Creativity
10	Readability
10	Organization
50	Completeness