goldmark-obsidian

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

goldmark-obsidian

★ 12 Open GitHub ↗

An Obsidian extension for the goldmark markdown parser

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# goldmark-obsidian

[![License MIT](https://img.shields.io/badge/license-MIT-royalblue.svg)](https://raw.githubusercontent.com/powerman/goldmark-obsidian/main/LICENSE)
[![Go version](https://img.shields.io/github/go-mod/go-version/powerman/goldmark-obsidian?color=blue)](https://go.dev/)
[![Test](https://img.shields.io/github/actions/workflow/status/powerman/goldmark-obsidian/test.yml?label=test)](https://github.com/powerman/goldmark-obsidian/actions/workflows/test.yml)
[![Coverage Status](https://raw.githubusercontent.com/powerman/goldmark-obsidian/gh-badges/coverage.svg)](https://github.com/powerman/goldmark-obsidian/actions/workflows/test.yml)
[![Release](https://img.shields.io/github/v/release/powerman/goldmark-obsidian?color=blue)](https://github.com/powerman/goldmark-obsidian/releases/latest)
[![Go Reference](https://pkg.go.dev/badge/github.com/powerman/goldmark-obsidian.svg)](https://pkg.go.dev/github.com/powerman/goldmark-obsidian)

![Linux | amd64 arm64 armv7 ppc64le s390x riscv64](https://img.shields.io/badge/Linux-amd64%20arm64%20armv7%20ppc64le%20s390x%20riscv64-royalblue)
![macOS | amd64 arm64](https://img.shields.io/badge/macOS-amd64%20arm64-royalblue)
![Windows | amd64 arm64](https://img.shields.io/badge/Windows-amd64%20arm64-royalblue)

An [Obsidian](https://obsidian.md/) extension for the
[goldmark](https://github.com/yuin/goldmark) markdown parser.

## Features

### Obsidian

- [x] Autolinks (GFM): `https://example.com`
- [x] Internal links: `[[Link]]`
- [x] Embed files: `![[Link]]`
- [x] Block references: `![[Link#^id]]`
- [x] Defining a block: `^id`
- [ ] Comments (block, inline): `%%Text%%`
- [x] Strikethroughs (GFM): `~~Text~~`
- [ ] Highlights: `==Text==`
- [x] Code blocks: ` ``` `
- [x] Incomplete task (GFM): `- [ ]`
- [x] Completed task (GFM): `- [x]`
- [ ] Callouts: `> [!note]`
- [x] Tables (GFM)
- [x] Footnotes (reference): `Example[^1].`
- [ ] Footnotes (inline): `Example. ^[This is an inline footnote.]`
- [x] Diagrams (Mermaid): ` ```mermaid `
- [x] LaTeX (MathJax): `$$`
- [x] Tags: `#tag`
- [x] Properties (metadata): `---` at the very beginning of a file

Known inconsistencies with Obsidian:

- Properties may start and end with at least 1 dash, not exactly 3 (---).
- Tags defined in properties are not applied to document in same way as other tags.
- Document aliases defined in properties are not processed as internal link targets.

TODO:

- Add basic tests for all syntax used in [Obsidian Help](https://help.obsidian.md/Home).
- Add support for comments (both block and inline).
- Add support for highlights.
- Add support for callouts.

Not planned (PR is welcome):

- Support for inline footnotes.

### Obsidian plugin [Tasks](https://github.com/obsidian-tasks-group/obsidian-tasks)

- [Supported task formats](https://publish.obsidian.md/tasks/Reference/Task+Formats/About+Task+Formats):
  - [x] [Tasks Emoji Format](https://publish.obsidian.md/tasks/Reference/Task+Formats/Tasks+Emoji+Format) - the default format
  - [ ] [Dataview Format](https://publish.obsidian.md/tasks/Reference/Task+Formats/Dataview+Format)
- [ ] [Optional Global Filter](https://publish.obsidian.md/tasks/Getting+Started/Global+Filter)
  - [ ] [Removing tag used as a Global Filter](https://publish.obsidian.md/tasks/Getting+Started/Tags#Tags+and+the+Global+Filter)
- [Dates](https://publish.obsidian.md/tasks/Getting+Started/Dates):
  - [x] [Due date](https://publish.obsidian.md/tasks/Getting+Started/Dates#Due+date)
  - [x] [Scheduled date](https://publish.obsidian.md/tasks/Getting+Started/Dates#Scheduled+date)
  - [x] [Start date](https://publish.obsidian.md/tasks/Getting+Started/Dates#Start+date)
  - [x] [Created date](https://publish.obsidian.md/tasks/Getting+Started/Dates#Created+date)
  - [x] [Done date](https://publish.obsidian.md/tasks/Getting+Started/Dates#Done+date)
- [x] [Cancelled date](https://publish.obsidian.md/tasks/Getting+Started/Dates#Cancelled+date)
  - [x] Detecting invalid dates
- [x] [Priority](https://publish.obsidian.md/tasks/Getting+Started/Priority)
- [x] [Recurring Tasks](https://publish.obsidian.md/tasks/Getting+Started/Recurring+Tasks)
  - Recurrence rule text is processed as is, without parsing a rule itself
- [x] [On Completion](https://publish.obsidian.md/tasks/Getting+Started/On+Completion)
- [x] [Statuses](https://publish.obsidian.md/tasks/Getting+Started/Statuses)
  - [x] [Custom Statuses](https://publish.obsidian.md/tasks/Getting+Started/Statuses#Custom+Statuses)
- [ ] [Use Filename as Default Date](https://publish.obsidian.md/tasks/Getting+Started/Use+Filename+as+Default+Date)
- [x] [Task Dependencies](https://publish.obsidian.md/tasks/Getting+Started/Task+Dependencies)

TODO:

- Add an option to support Global Filter (with tag removal).
- Add an option to set a Default Date.

Not planned (PR is welcome):

- Dataview Format.

## Installation

```sh
go get github.com/powerman/goldmark-obsidian
```

## Usage

```go
source := []byte(`
- [ ] Happy New Year 📅 2025-01-01 ^first-task
- [x] Happy Old Year 📅 2024-01-01
`)

md := goldmark.New(
    goldmark.WithExtensions(
        obsidian.NewPlugTasks(),
        obsidian.NewObsidian(),
    ),
)
err := md.Convert(source, os.Stdout)
if err != nil {
    fmt.Println(err)
}
// Output:
// <ul class="contains-task-list">
// <li data-task="" class="task-list-item" id="^first-task"><input disabled="" type="checkbox" class="task-list-item-checkbox"> Happy New Year 📅 2025-01-01</li>
// <li data-task="x" class="task-list-item is-checked"><input checked="" disabled="" type="checkbox" class="task-list-item-checkbox"> Happy Old Year 📅 2024-01-01</li>
// </ul>
```

goldmark-obsidian

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README