https://github.com/JulesGuesnon/obsidian-markdown-shortcuts

🪨 Obsidian plugin that allows to write markdown from commands
https://github.com/JulesGuesnon/obsidian-markdown-shortcuts

obsidian obsidian-md obsidian-plugin

Last synced: about 1 month ago
JSON representation

🪨 Obsidian plugin that allows to write markdown from commands

• Host: GitHub
• URL: https://github.com/JulesGuesnon/obsidian-markdown-shortcuts
• Owner: JulesGuesnon
• License: mit
• Created: 2022-02-12T11:57:35.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-18T18:44:41.000Z (about 2 years ago)
• Last Synced: 2024-06-17T22:48:35.026Z (7 months ago)
• Topics: obsidian, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 391 KB
• Stars: 25
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - JulesGuesnon/obsidian-markdown-shortcuts - 🪨 Obsidian plugin that allows to write markdown from commands (TypeScript)

README

        
[![Release number](https://img.shields.io/github/release/JulesGuesnon/obsidian-markdown-commands.svg)](https://GitHub.com/Naereen/StrapDown.js/releases/) [![Github all releases](https://img.shields.io/github/downloads/JulesGuesnon/obsidian-markdown-commands/total.svg)](https://GitHub.com/Naereen/StrapDown.js/releases/)

# Obsidian Markdown Shortcuts

This is a plugin for Obsidian (https://obsidian.md).

# Why?

If you're used to software like Notion, going from assisted markdown to plain markdown may be a bit hard if you're not used to it. You'll probably have to work with a [cheatsheet](https://www.markdownguide.org/cheat-sheet/) open in a tab in order to make sure you're not doing it wrong. 


Also some syntaxes are a bit cumbersome to write like the [table](https://www.markdownguide.org/cheat-sheet/#extended-syntax) one.

So, if you're learning markdown or too lazy to write a table, this plugin is for you.

# How it works?

## Show the commands

All you have to do is to write a `>` whenever you want in a file, then make your choice.

![example.gif](./images/example.gif)

## Configure the plugin

-   `Trigger character` Set the character that will trigger the commands.

-   `Simple commands` Insert commands without examples.

![settings.png](./images/settings.png)

# How to install?

First, you need to have `Obsidian v0.12.17+`.

-   Go to `Settings > Community plugins`

-   Turn safe mode to `off`

-   Go to the [releases page](https://github.com/JulesGuesnon/obsidian-markdown-commands/releases)

-   Download the latest `markdown-commands-.zip`

-   Put the zip into `/.obsidian/plugins` (if the folder plugins doesn't exist you can create it)

-   Extract it

-   Enable the plugin in the settings and you're ready to go

![enable.png](./images/enable.png)

# Any issue or suggestion?

If you're facing an issue feel free to [open a new one](https://github.com/JulesGuesnon/obsidian-markdown-commands/issues/new) and describe as much as possible the issue, the context of the issue, etc...

If you think that the plugin is missing something or could be improved, feel free to [open an issue](https://github.com/JulesGuesnon/obsidian-markdown-commands/issues/new) and describe your idea.