Skip to content

nnkn/obsidian-prettify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

A #new and #exciting paragraph!

After 'Update fields':

---
tags:
    - '#new'
    - '#exciting'

---

A #new and #exciting paragraph!

Update values in the frontmatter

Before:

I wrote this, but I don't remember when!

After:

---
date updated: '2020-11-23T16:47:37+01:00'
---

I wrote this, but I don't remember when!

Autolink literals

Example

Before:

www.example.com, https://example.com, and contact@example.com.

After:

[www.example.com](http://www.example.com), <https://example.com>, and <contact@example.com>.

Ordered lists

Normalizes ordered lists.

Example

Before:

1. foo
    1. aaa
    1. bbb
    4. ccc
1. bar
1. baz

After:

1.  foo
    1.  aaa
    2.  bbb
    3.  ccc
2.  bar
3.  baz

Tables

Normalizes table formatting.

Example

Before:

**A**|**B**|**C**
|---:|:---|---|
a |b |c
x |y |z

After:

| **A** | **B** | **C** |
| ----: | :---- | ----- |
|     a | b     | c     |
|     x | y     | z     |

This plugin uses the following amazing libraries

How to compile the plugin

First, install the dependencies with

npm i

Then, you can compile the plugin with:

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. Extract the archive into <vault>/.obsidian/plugins.

Alternatively, using 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.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

v0.0.2

Added tests!

Included: remark-gfm and 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


Pull requests are both welcome and appreciated. :)

if you want, you can also send me a coffee https://www.buymeacoffee.com/pelado

About

A markdown prettifier for obsidian

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 79.2%
  • TypeScript 20.8%