Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mordechaihadad/infobox-creator
Infobox plugin? I have no idea if something will come out of this.
https://github.com/mordechaihadad/infobox-creator
Last synced: 2 months ago
JSON representation
Infobox plugin? I have no idea if something will come out of this.
- Host: GitHub
- URL: https://github.com/mordechaihadad/infobox-creator
- Owner: MordechaiHadad
- License: mit
- Created: 2023-07-27T14:15:53.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-11T13:31:16.000Z (5 months ago)
- Last Synced: 2024-08-12T12:27:45.968Z (5 months ago)
- Language: TypeScript
- Size: 59.6 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Infobox Creator
Obsidian Infobox is a TOML based infobox creator plugin for Obsidian. This plugin allows you to enhance your notes by adding infoboxes with an easy-to-understand syntax.
## Showcase
## Installation
You can install the Obsidian Infobox plugin via Obsidian’s third-party plugin community. Here's how:
1. Open Obsidian.
2. Go to `Settings > Third-party plugins`.
3. Make sure `Safe mode` is turned off.
4. Click `Browse`, then search for `Infobox Creator`.
5. Click `Install`, then `Enable`.
## Usage
With Obsidian Infobox, you can generate infoboxes within your notes. The syntax is simple and easy to adopt.
```toml
title = "Your title here"
image = "https://your-image.com"
field_name = "your field content here"
```
### Properties
#### `title` (string)
This is the infobox title. Accepts a string.
Example:
```toml
title = "This is an Infobox"
```
#### `image` (string)
The image for the infobox. Accepts http or https links.
Example:
```toml
image = "https://example.com/image.png"
```
#### Custom Properties
Any other property not named `title` or `image` will be treated as an infobox field.
- Basic field:
```toml
property_name = "A basic string"
```
- Field with an array of strings:
```toml
property_name = ["String1", "String2", "String3"]
```
- Field with a link associated with the text:
```toml
property_name = {content = "Your content here", link = "https://your-link.com"}
```
OR
```toml
property_name = {content = "Your content here", link = "[[Note Name]]"}
```
## Support
For any question or issue, feel free to report at [GitHub issue](#). Stay tuned for other properties for enhancing your infobox experience!