https://github.com/garlicbreadcleric/vscode-markane

VS Code client for Markane — a Markdown language server
https://github.com/garlicbreadcleric/vscode-markane

knowledge-management language-client markdown vscode

Last synced: about 1 month ago
JSON representation

VS Code client for Markane — a Markdown language server

• Host: GitHub
• URL: https://github.com/garlicbreadcleric/vscode-markane
• Owner: garlicbreadcleric
• License: mit
• Created: 2022-12-19T15:14:29.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-12T13:36:05.000Z (about 3 years ago)
• Last Synced: 2026-02-19T04:40:25.678Z (4 months ago)
• Topics: knowledge-management, language-client, markdown, vscode
• Language: TypeScript
• Homepage:
• Size: 1.19 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Markane for VS Code

[VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=garlicbreadcleric.markane) |

[Open VSX](https://open-vsx.org/extension/garlicbreadcleric/markane) |

[GitHub](https://github.com/garlicbreadcleric/vscode-markane)

_Arcane focus for Markdown spell-casting_

## Description

Markane is a command-line tool for taking Markdown notes and navigating between them. The preferred Markdown dialect is Pandoc Markdown, although you can use it with CommonMark if you don't use some Pandoc-related features. Markane features include:

- Creating notes from Handlebars templates

- Preview on hover (links, images, citations)

- Auto-completion (links, citations, snippets)

- Go-to-definition (links, citations)

- Backlinks (links, citations)

## Documentation

- [Getting started](https://github.com/garlicbreadcleric/markane/blob/main/docs/getting-started.md)

- [Editor integration](https://github.com/garlicbreadcleric/markane/blob/main/docs/editor-integration.md)

- [Template examples](https://github.com/garlicbreadcleric/markane/blob/main/docs/template-examples.md)

## Features

### Auto-completion

Links

![](assets/completion-link.gif)

Citations

![](assets/completion-citation.gif)

### Preview on hover

Links

![](assets/preview-link.gif)

Citations

![](assets/preview-citation.gif)

### Go to definition

Links

![](assets/definition-link.gif)

Citations

![](assets/definition-citation.gif)

### Backlinks

Links

![](assets/reference-link.gif)

Citations

![](assets/reference-citation.gif)

## Similar projects

- mickael-menu's [zk](https://github.com/mickael-menu/zk) — a similar tool with a more powerful command-line interface. Supports `[[wiki-links]]` and `#hashtags` and has the ability to query notes from CLI; doesn't support `@citations` and `/snippets`.