{"id":28935085,"url":"https://github.com/heavycircle/remark-obsidian","last_synced_at":"2026-05-12T17:01:38.078Z","repository":{"id":252156265,"uuid":"839597116","full_name":"heavycircle/remark-obsidian","owner":"heavycircle","description":"A remark plugin to support Obsidian-flavored Markdown additions","archived":false,"fork":false,"pushed_at":"2025-05-26T03:47:11.000Z","size":38,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-26T04:03:19.538Z","etag":null,"topics":["markdown","obsidian","plugin","remark"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heavycircle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-08T00:10:40.000Z","updated_at":"2025-05-26T03:47:14.000Z","dependencies_parsed_at":"2024-08-08T02:42:57.114Z","dependency_job_id":"fb602ac5-83d0-40ec-bda7-ad9424d25437","html_url":"https://github.com/heavycircle/remark-obsidian","commit_stats":null,"previous_names":["thecae/remark-obsidian","coleellis/remark-obsidian","heavycircle/remark-obsidian"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/heavycircle/remark-obsidian","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavycircle%2Fremark-obsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavycircle%2Fremark-obsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavycircle%2Fremark-obsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavycircle%2Fremark-obsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heavycircle","download_url":"https://codeload.github.com/heavycircle/remark-obsidian/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavycircle%2Fremark-obsidian/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261348752,"owners_count":23145315,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","obsidian","plugin","remark"],"created_at":"2025-06-22T19:10:25.339Z","updated_at":"2026-05-12T17:01:37.918Z","avatar_url":"https://github.com/heavycircle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remark-obsidian\n\nA [remark](https://github.com/remarkjs/remark) plugin to extend support to [Obsidian](https://obsidian.md/)-flavored Markdown.\n\n## Contents\n\n- [What is this?](#what-is-this)\n- [Install](#install)\n- [Use](#use)\n- [API](#api)\n- [Security](#security)\n- [License](#license)\n\n## What is this?\n\nThis package is a [unified](https://unifiedjs.com) ([remark](https://github.com/remarkjs/remark)) package that extends Markdown to support [Obsidian flavors](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown).\n\nThe list of Supported Obsidian Markdown items are:\n\n| **Syntax**      | **Description**  |\n| --------------- | ---------------- |\n| `[[Link]]`      | Internal Links   |\n| `![[Link]]`     | Embed Files      |\n| `![[Link#^id]]` | Block References |\n| `^id`           | Defining a Block |\n| `%%Text%%`      | Comments         |\n| `~~Text~~`      | Strikethroughs   |\n| `==Text==`      | Highlights       |\n| ` ``` `         | Code Blocks      |\n| `- [ ]`         | Incomplete Task  |\n| `- [x]`         | Completed Task   |\n| `[!note]`       | Callouts         |\n\n_Obsidian's website notes that not all these are fully Obsidian-specific. The main reason I wrote this plugin is for Link and Callout support_.\n\n## Install\n\nThis package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js (version 16+), install using [`npm`](https://docs.npmjs.com/cli/install):\n\n```bash\nnpm install @heavycircle/remark-obsidian\n```\n\n## Use\n\nMost definitions are self-explanatory from the above table. However, it is worth mentioning the various Callout syntaxes available.\n\nUse the [Obsidian Callouts](https://help.obsidian.md/Editing+and+formatting/Callouts) guide for further instruction.\n\nThis plugin is best used with [remark-gfm](https://www.npmjs.com/package/remark-gfm), [rehype-raw](https://www.npmjs.com/package/rehype-raw), and [remark-wiki-link-plus](https://www.npmjs.com/package/remark-wiki-link-plus).\n\n## API\n\nThis package exports no identifiers. The default export is `remarkObsidian`.\n\n#### `unified().use(remarkObsidian)`\n\nProvides support for Obsidian-flavored Markdown, including tables, callouts, links, embeds, and more.\n\nTo get full use of the package, ensure you include Obsidian-compliant variables. Then, import the CSS file inside the `global.css` file:\n\n```css\n@import \"@heavycircle/remark-obsidian/obsidian.module.css\";\n```\n\n###### Parameters\n\nThere are no parameters.\n\n###### Returns\n\nTransform ([`Transformer`](https://github.com/unifiedjs/unified#transformer)).\n\n# Security\n\nUse of remark-videos does not involve [rehype](https://github.com/rehypejs/rehype) ([hast](https://github.com/syntax-tree/hast)) or user content so there are no openings for [cross-site scripting (XSS)](https://en.wikipedia.org/wiki/Cross-site_scripting) attacks.\n\n\n# License\n\n[MIT](LICENSE) \u0026copy; heavycircle\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheavycircle%2Fremark-obsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheavycircle%2Fremark-obsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheavycircle%2Fremark-obsidian/lists"}