https://github.com/johackim/remark-obsidian

Remark plugin to support Obsidian markdown syntax
https://github.com/johackim/remark-obsidian

nodejs obsidian remark

Last synced: 6 days ago
JSON representation

Remark plugin to support Obsidian markdown syntax

• Host: GitHub
• URL: https://github.com/johackim/remark-obsidian
• Owner: johackim
• License: gpl-3.0
• Created: 2022-05-08T15:43:56.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-07T18:54:45.000Z (about 1 year ago)
• Last Synced: 2024-09-18T18:26:33.089Z (15 days ago)
• Topics: nodejs, obsidian, remark
• Language: JavaScript
• Homepage:
• Size: 53.7 KB
• Stars: 48
• Watchers: 2
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# remark-obsidian

[![Version](https://img.shields.io/npm/v/remark-obsidian.svg?colorA=181C31&colorB=212839&label=version&sort=semver&style=flat-square)](https://www.npmjs.com/package/remark-obsidian)

[![License](https://img.shields.io/badge/license-GPL%20v3%2B-yellow.svg?style=flat-square&colorA=181C31&colorB=212839)](https://raw.githubusercontent.com/johackim/remark-obsidian/master/LICENSE.txt)

Remark plugin to support Obsidian markdown syntax.

## Requirements

- Nodejs >= 14

## Features

- [x] Support `> [!CALLOUT]`

- [x] Support `==highlight text==`

- [x] Support `[[Internal link]]`

- [x] Support `[[Internal link|With custom text]]`

- [x] Support `[[Internal link#heading]]`

- [x] Support `[[Internal link#heading|With custom text]]`

- [x] Support `![[Embed note]]`

- [ ] Support `![[Embed note#heading]]`

## Installation

```bash

yarn add -D remark-obsidian

```

## Usage

With [remark](https://github.com/remarkjs/remark/) :

```js

import { remark } from 'remark';

import remarkObsidian from 'remark-obsidian';

const html = String(await remark().use(remarkObsidian).process('[[Hello world]]'));

console.log(html); // Hello world

```

With [unified](https://github.com/unifiedjs/unified) :

```js

import { unified } from 'unified'

import remarkObsidian from 'remark-obsidian';

import remarkParse from 'remark-parse';

import remarkRehype from 'remark-rehype';

import rehypeStringify from 'rehype-stringify';

const { value } = unified()

    .use(remarkParse)

    .use(remarkObsidian)

    .use(remarkRehype, { allowDangerousHtml: true })

    .use(rehypeStringify, { allowDangerousHtml: true })

    .processSync('[[Hello world]]');

console.log(value); // Hello world

```

## Running the tests

```bash

npm test

```

## License

This project is licensed under the GNU GPL v3.0 - see the [LICENSE](https://raw.githubusercontent.com/johackim/remark-obsidian/master/LICENSE.txt) file for details

**Free Software, Hell Yeah!**