No description
Find a file
2024-10-22 12:57:27 +02:00
.github/workflows ci: 👷 2024-08-11 10:49:01 +02:00
assets feat: 📝 add video 2024-10-22 12:57:27 +02:00
.editorconfig use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
.eslintignore fix .eslintignore (#48) 2023-01-19 10:06:51 -05:00
.eslintrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
.gitignore Update .gitignore (#25) 2022-01-28 10:34:53 -05:00
.npmrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
esbuild.config.mjs Upgrade esbuild to v0.17.x (#47) 2023-01-25 13:49:50 -05:00
LICENSE Create LICENSE 2024-08-11 11:07:51 +02:00
main.ts docs: 📝 Translate to english 2024-10-22 12:11:51 +02:00
manifest.json docs: 📝 Translate to english 2024-10-22 12:11:51 +02:00
package-lock.json feat: Colors, Sorting and canvas summary 2024-10-01 16:25:06 +02:00
package.json ci: 💚 Update plugin description for obsidian CI 2024-08-11 12:40:40 +02:00
README.md feat: 📝 add video 2024-10-22 12:57:27 +02:00
styles.css Update sample css file. 2022-08-09 13:39:02 -04:00
tsconfig.json Fix inconsistent indentation 2024-01-19 21:14:58 +02:00
types.ts ci: 💚 Fix Types for CI 2024-08-11 10:58:28 +02:00
version-bump.mjs add version bump script (#10) 2022-01-22 16:13:50 -05:00
versions.json Update for 0.15 2022-08-09 13:38:50 -04:00

🦉 Canvas Explorer

Canvas Explorer is an Obsidian plugin that allows you to explore your vault by adding or ignoring linked notes, generating a customizable canvas.

Canvas Explorer Demo

🚀 Features

  • Add notes to an exploration stack
  • Ignore unwanted notes
  • Automatically create a canvas with preserved notes and their connections
  • Customizable node dimensions and canvas folder location
  • Sort notes based on a frontmatter property or creation date
  • Exclude specific sections from notes
  • Concatenate note content in a separate node
  • Color-code notes based on their connection count
  • Generate a summary node with concatenated content

🛠️ Installation

  1. Open Obsidian and go to Settings
  2. Navigate to Community Plugins and disable Safe Mode
  3. Click on Browse and search for "Canvas Explorer"
  4. Click Install and then Enable the plugin

🎮 Usage

  1. Open a note to start exploring
  2. Use the "Add Note" command to add it to the exploration stack
  3. Navigate through suggested linked notes using "Add Note" or "Ignore Note"
  4. Once exploration is complete, name your canvas
  5. A new canvas will be created with all preserved notes and their connections

⌨️ Commands

  • Add Note: Adds the current note to the exploration stack
  • Ignore Note: Skips the current note and moves to the next

⚙️ Settings

  • Canvas Folder: Folder to save generated canvases
  • Node Width: Width of note nodes in the canvas (in pixels)
  • Node Height: Height of note nodes in the canvas (in pixels)
  • Sort Property: Frontmatter property for sorting notes
  • Excluded Sections: Section titles to exclude from concatenation

🎨 Color Coding

Notes are color-coded based on their number of connections:

  • Red: Most connected
  • Orange
  • Yellow
  • Purple
  • Blue: Least connected

This visual cue helps identify central or highly connected notes in your knowledge graph.

📊 Note Sorting

Notes are sorted based on the specified frontmatter property or creation date if not found. This allows for chronological or custom-ordered exploration of your notes.

📝 Concatenated Summary Node

A separate, larger node is created containing the concatenated content of all explored notes. This provides a comprehensive overview of the explored topic. The summary node is color-coded green for easy identification.

🐛 Support

To report issues or suggest improvements, visit our GitHub repository.

👤 Author

Developed by Henri Jamet. More information at https://www.henri-jamet.com/.

📄 License

Canvas Explorer is under the MIT License. See the LICENSE file for more details.