🔌 Vault Summary Engine – Obsidian Plugin

Generate quick overviews of your notes without leaving Obsidian.

Welcome to Vault Summary Engine, an Obsidian plugin that scans your vault and produces a concise summary of each note. The plugin is written in TypeScript and compiled with Rollup.

---

🧰 Features

• 🗂 Index every Markdown file in your vault
• 📝 Calculate word counts, reading time and common keywords
• 🪄 Display results in a right‑side panel with quick links
• ⚙️ Simple settings to control which folders are scanned

---

🚀 Getting Started

Clone this repository and install the dependencies:

git clone https://github.com/PtiCalin/vault_summary-engine.git
cd vault_summary-engine
npm install

In Codex environments, .config/setup.sh runs automatically to install dependencies.

Build the plugin to generate dist/main.js:

npm run build

Copy manifest.json, styles.css and dist/main.js into your Obsidian vault's .obsidian/plugins/vault-summary-engine/ folder and enable the plugin from Obsidian's settings. Refer to versions.json for the minimum supported Obsidian version for each plugin release.

Setup Notes

Dependencies are installed automatically by .config/setup.sh. If you are in an offline environment, request or configure outbound internet access so this script can run, or prepackage the node_modules directory.

---

🧱 Folder Structure

src/           → TypeScript source files
styles.css     → Plugin styles
manifest.json  → Obsidian plugin manifest
dist/main.js   → Compiled output
versions.json  → Maps plugin versions to minimum Obsidian version

---

🤝 Contributing

Contributions are welcome! Feel free to open issues or pull requests. See CONTRIBUTING.md for guidelines.

---

🚢 Publishing a Release

Before creating a release, ensure the compiled file is up to date by running:

npm run build

---

📜 License

This project is licensed under the MIT License.