https://github.com/decaf-dev/obsidian-dashboards
Create your own personalized dashboards using customizable grid views
https://github.com/decaf-dev/obsidian-dashboards
Last synced: 11 months ago
JSON representation
Create your own personalized dashboards using customizable grid views
- Host: GitHub
- URL: https://github.com/decaf-dev/obsidian-dashboards
- Owner: decaf-dev
- License: mit
- Created: 2023-07-11T19:27:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T08:00:55.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T13:11:39.069Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 900 KB
- Stars: 44
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Dashboards is an [Obsidian.md](https://obsidian.md/) plugin. Design your own personalized dashboard or home page. Dashboards offers flexible grid configurations, allowing you to choose from various layouts such as 1x2, 2x2, 3x3, and more. Each grid contains containers where you can embed different elements, including vault files, code blocks, or external urls.
If you are looking for the plugin that was formally called `Dashboards` please see [DataLoom](https://github.com/decaf-dev/obsidian-dataloom)
## About
- [Screenshots](#screenshots)
- [Getting started](#getting-started)
- [Embeddable Items](#embeddable-items)
- [License](#license)
## Screenshots
Create a grid layout
Add embedded content with ease
Use many different layouts
## Getting Started
1. Create a new dashboard file by right clicking a folder and clicking "New dashboard" or click the Gauge icon on the left sidebar.
2. Choose your grid layout using the dropdown in the upper righthand corner
3. In each container click one of the embed buttons and enter the content you wish to embed. You may choose from a vault file, a code block, or a external link.
### Removing an embed
To remove an embed from a container, hold down ctrl (Windows) or cmd (Mac) and hover over a container to show the remove button. Then click the remove button
## Embeddable Items
### Files
Any vault files may be embedded into a container
### Code blocks
Embed any Obsidian code block using the [normal code block syntax](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Code+blocks). This may be used to render [Dataview](https://github.com/blacksmithgu/obsidian-dataview), DataviewJS, or [Tasks](https://github.com/obsidian-tasks-group/obsidian-tasks) plugin code blocks.
### Links
Any website will automatically be embedded in an iFrame
## License
Dashboards is distributed under the [MIT License](https://github.com/decaf-dev/obsidian-dashboards/blob/master/LICENSE)