https://github.com/scottTomaszewski/obsidian-inline-admonitions
https://github.com/scottTomaszewski/obsidian-inline-admonitions
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/scottTomaszewski/obsidian-inline-admonitions
- Owner: scottTomaszewski
- License: mit
- Created: 2024-01-24T02:22:11.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-24T20:16:37.000Z (6 months ago)
- Last Synced: 2024-10-25T23:19:13.030Z (6 months ago)
- Language: TypeScript
- Size: 2.64 MB
- Stars: 20
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - scottTomaszewski/obsidian-inline-admonitions - (TypeScript)
README
# Inline Admonitions for Obsidian
This plugin will allow you to format inline codeblocks to better stand out on the page. For example, you may want to
have all inline codeblocks that start with "IMPORTANT" to have a red background like this.
[inlineAdmonition_1.2.0.webm](https://github.com/scottTomaszewski/obsidian-inline-admonitions/assets/5295276/2a781588-cba0-4665-98c2-16d896cd2abe)
## Usage
To add an Inline Admonition to your note, first [create a new Inline Admonition](#Creating a new Inline Admonition) of
the desired [type](#types).
Then add an
[inline codeblock](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Inline+code)
with the appropriate trigger text. For example, a [Prefix Inline Admonition](#Prefix Type) with a prefix of `IMPORTANT` will
trigger when an inline codeblock starts with "IMPORTANT", like this:
```
Normal text `IMPORTANT - dont forget the milk!` and some more normal text
```
## Creating a new Inline Admonition
Open the "Inline Admonition" settings and click "Create New Inline Admonition" at the top to bring up a Modal to
configure a new Inline Admonition.
- **Background Color** is the color of the Inline Admonition "bubble"
- **Color** is the text color
- **Type** defines how an Inline Admonition is triggered. See the [types](#types) documentation for more details.
## Types
The Inline Admonition "Type" defines what triggers the codeblock to convert into an Inline Admonition. Current supported
Types are:
- [Prefix Type](#prefix-type)
- [Suffix Type](#suffix-type)
- [Contains Type](#contains-type)
### Prefix Type
Prefix Inline Admonitions trigger when a codeblock starts with specific text.
**Settings**
- `Prefix` defines the text at the start of the codeblock to trigger the Inline Admonition.
- `Hide prefix text` - if enabled, the triggering prefix text will not show in the Inline Admonition.
### Suffix Type
Suffix Inline Admonitions trigger when a codeblock ends with specific text.
**Settings**
- `Suffix` defines the text at the end of the codeblock to trigger the Inline Admonition.
- `Hide suffix text` - if enabled, the triggering suffix text will not show in the Inline Admonition.
### Contains Type
Contains Inline Admonitions trigger when a codeblock contains specific text anywhere within it.
**Settings**
- `contains` defines the text within the codeblock to trigger the Inline Admonition.
## Notes
- The CSS of the Inline Admonitions rides on Obsidian's Tag css. I'll clean this up in a future release.
- Saving settings will trigger a re-render of the markdown views. Its possible to avoid this and is planned for a future release
- Similar to Contexual Typography this plugin will give you some css classes that you can manually manipulate
## Future work
- Regex to trigger Inline Admonitions
- Additional admonitions styles (rounded corners, etc)
- More comprehensive CSS editing in the settings UI
### Known Issues
- Newly created inline admonitions might not render in Live Preview. Reload the app as a workaround
## Development
See the [changelog](CHANGELOG.md) for changes
### Build
- `npm i` to install deps
- `npm run dev` to build and watch
### Release
Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments