Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cristianvasquez/obsidian-prettify
A markdown prettifier for obsidian
https://github.com/cristianvasquez/obsidian-prettify
markdown obsidian obsidian-md obsidian-plugin
Last synced: 2 months ago
JSON representation
A markdown prettifier for obsidian
- Host: GitHub
- URL: https://github.com/cristianvasquez/obsidian-prettify
- Owner: cristianvasquez
- License: gpl-3.0
- Created: 2020-11-11T19:11:14.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-28T14:33:31.000Z (almost 3 years ago)
- Last Synced: 2024-10-23T06:10:13.316Z (3 months ago)
- Topics: markdown, obsidian, obsidian-md, obsidian-plugin
- Language: JavaScript
- Homepage:
- Size: 526 KB
- Stars: 129
- Watchers: 3
- Forks: 12
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - cristianvasquez/obsidian-prettify - A markdown prettifier for obsidian (JavaScript)
- jimsghstars - cristianvasquez/obsidian-prettify - A markdown prettifier for obsidian (JavaScript)
README
# Note: No longer maintained
For similar functionality I recommend: [obsidian-linter](https://github.com/platers/obsidian-linter) ( I'm using it myself 🙂 )
# Markdown prettifier for Obsidian
Tries to fix and reformat ugly Markdown and adds things like 'modified date' etc.
The default hotkey is `Ctrl+Alt+L`.
## Examples
### Hashtags janitor
Say you have:
```markdown
A #new and #exciting paragraph!
```
After 'Update fields':
```markdown
---
tags:
- '#new'
- '#exciting'
---
A #new and #exciting paragraph!
```
### Update values in the frontmatter
Before:
```markdown
I wrote this, but I don't remember when!
```
After:
```markdown
---
date updated: '2020-11-23T16:47:37+01:00'
---
I wrote this, but I don't remember when!
```
Headers can be configured through a template, to add dates or IDs
To generate dates you can use the [moment.js format](https://momentjs.com/docs/#/displaying/format), like
```
date created: '{{date}}'
```
```
date updated: '{{date:YYYY-MM-DDTHH:mm:ssZ}}'
```
To generate RFC4122 UUID (universal Ids), use the following format:
```
id: {{UUID}}
```
### Autolink literals
**Example**
Before:
```markdown
www.example.com, https://example.com, and [email protected].
```
After:
```markdown
[www.example.com](http://www.example.com), , and .
```
### Ordered lists
Normalizes ordered lists.
**Example**
Before:
```markdown
1. foo
1. aaa
1. bbb
4. ccc
1. bar
1. baz
```
After:
```markdown
1. foo
1. aaa
2. bbb
3. ccc
2. bar
3. baz
```
### Tables
Normalizes table formatting.
**Example**
Before:
```markdown
**A**|**B**|**C**
|---:|:---|---|
a |b |c
x |y |z
```
After:
```markdown
| **A** | **B** | **C** |
| ----: | :---- | ----- |
| a | b | c |
| x | y | z |
```
## Other similar plugins
Other alternatives to check out :)
- [obsidian-plugin-prettier](https://github.com/hipstersmoothie/obsidian-plugin-prettier)
- [Obsidian Linter](https://github.com/platers/obsidian-linter)
## This plugin uses the following libraries
- [remark](https://github.com/remarkjs/remark)
- [remark-gfm](https://github.com/remarkjs/remark-gfm#readme)
- [remark-images](https://github.com/remarkjs/remark-images)
- [remark-frontmatter](https://github.com/wooorm/remark-frontmatter)
## How to compile the plugin
First, install the dependencies with
```bash
npm i
```
Then, you can compile the plugin with:
```bash
npm run build
```
This will create a `main.js` file in the project root. That is the entry point of your plugin.
## Manual installation
Download zip archive from [GitHub releases page](https://github.com/cristianvasquez/obsidian-prettify/releases).
Extract the archive into `/.obsidian/plugins`.
Alternatively, using bash:
```bash
OBSIDIAN_VAULT_DIR=/path/to/your/obsidian/vault
mkdir -p $OBSIDIAN_VAULT_DIR/.obsidian/plugins
unzip ~/Downloads/obsidian-prettify-0.1.zip -d $OBSIDIAN_VAULT_DIR/.obsidian/plugins
```
## Version History
### v.1.1
- Fixed some escaping bugs
- Removed space for frontmatter
### v.0.0.9
- Separation between new header template and update template
- UUID support
### v.0.0.7
- New Refactor tags functionality (ctrl+shift+o)
- Can add emoticons as tags
### v.0.0.6
Fixed frontmatter bug
### v.0.0.5
Added indent for lists
Sets settings as recommended
### v.0.0.4
Fixed a bug that escaped \\
Added some feedback to the user
### v0.0.3
Enabled frontmatter and settings!
Included: [remark-frontmatter](https://github.com/wooorm/remark-frontmatter)
### v0.0.2
Added tests!
Included: [remark-gfm](https://github.com/remarkjs/remark-gfm#readme) and [remark-images](https://github.com/remarkjs/remark-images)
### v0.0.1
Initial Release, just playing around for the first time with Obsidian and the plugins. No settings, Just the minimum possible
## Disclaimer
This plugin is provided as is, and is focused on my personal use of Obsidian on Linux. As such it is not thoroughly tested across all operating systems and features of Obsidian.
---
Pull requests are both welcome and appreciated. :)
> I love coffee, you can send me one here: :D