Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/powerman/goldmark-obsidian
An Obsidian extension for the goldmark markdown parser
https://github.com/powerman/goldmark-obsidian
go golang goldmark goldmark-extension markdown obsidian obsidian-markdown-parser obsidian-plugins obsidian-tasks
Last synced: about 1 month ago
JSON representation
An Obsidian extension for the goldmark markdown parser
- Host: GitHub
- URL: https://github.com/powerman/goldmark-obsidian
- Owner: powerman
- License: mit
- Created: 2024-10-19T11:56:36.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-07T09:43:13.000Z (3 months ago)
- Last Synced: 2024-12-08T19:13:58.121Z (about 2 months ago)
- Topics: go, golang, goldmark, goldmark-extension, markdown, obsidian, obsidian-markdown-parser, obsidian-plugins, obsidian-tasks
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goldmark-obsidian
[](https://pkg.go.dev/github.com/powerman/goldmark-obsidian)
[](https://github.com/powerman/goldmark-obsidian/actions/workflows/CI&CD.yml)
[](https://coveralls.io/github/powerman/goldmark-obsidian?branch=master)
[](https://goreportcard.com/report/github.com/powerman/goldmark-obsidian)
[](https://github.com/powerman/goldmark-obsidian/releases/latest)
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:
//
- Happy New Year 📅 2025-01-01
- Happy Old Year 📅 2024-01-01
//
//
//
```