Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dragonish/obsidian-abbreviations
Makes Obsidian can mark abbreviations and acronyms (terminology) automatically.
https://github.com/dragonish/obsidian-abbreviations
abbreviations acronyms metadata obsidian obsidian-plugin terminology
Last synced: 30 days ago
JSON representation
Makes Obsidian can mark abbreviations and acronyms (terminology) automatically.
- Host: GitHub
- URL: https://github.com/dragonish/obsidian-abbreviations
- Owner: dragonish
- License: mit
- Created: 2024-07-23T06:10:15.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T04:02:03.000Z (4 months ago)
- Last Synced: 2024-10-01T09:41:03.604Z (about 1 month ago)
- Topics: abbreviations, acronyms, metadata, obsidian, obsidian-plugin, terminology
- Language: TypeScript
- Homepage:
- Size: 590 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Abbreviations and Acronyms
> Obsidian Plugin
## Introduction
This is a plugin for [Obsidian](https://obsidian.md).
Implements automatic marking of abbreviations and acronyms (terminology).
## Usage
Gets the abbreviations by reading the specified field in the note [properties(metadata)](https://help.obsidian.md/Editing+and+formatting/Properties), and automatically render the abbreviations in the note content.
This plugin supports rendering in both editing view (*Live Preview*) and reading view.
### Metadata format
You can use arrays of strings or key-value pairs.
#### Strings
Use a colon (`:`) in the string to separate the abbreviation and the tooltip.
Example:
```yaml
---
abbr:
- "HTML: HyperText Markup Language"
- "CSS: Cascading Style Sheets"
---
```
> [!TIP]
> The advantage of this format is that abbreviations can be added or removed directly in display mode.
#### Key-value pairs
Use the abbreviation for key and the tooltip for value.
Example:
```yaml
---
abbr:
- HTML: HyperText Markup Language
- CSS: Cascading Style Sheets
---
```
## Settings
### Metadata keyword
This plugin allows you to customize the keyword that read abbreviations from [properties](https://help.obsidian.md/Editing+and+formatting/Properties), default value is `abbr`.
### Global abbreviations
This plugin allows you to customize globally available abbreviations.
If you want to disable a specific abbreviation in your notes, you can declaring the abbreviation as an empty string value in the [properties](https://help.obsidian.md/Editing+and+formatting/Properties).
Example:
```yaml
---
abbr:
- "HTML: " # string format
- CSS: "" # key-value pair format
---
```
## Preview
**Live Preview:**
| Source mode | Live Preview |
| :---------: | :----------: |
|  |  |
**Reading:**
| Source mode | Reading |
| :---------: | :-----: |
|  |  |
## License
[MIT](/LICENSE) license