agucova / anymd-as-md-obsidian

A (forked) plugin for Obsidian which allows editing of `qmd` and `rmd` files.

anymd as md Obsidian plugin

A plugin for Obsidian which allows editing of qmd and rmd files as if they were normal markdown files. Quarto (.qmd) is the next generation format meant to replace Rmarkdown (.rmd).

To be able to use linking with the any of these files you need to check the toggle "detect all files extension" in Files & Links section in Obsidian (which will override the default behaviour of Obsidian to only detect markdown files, including unrelated files).

To hide additional files you might use this CSS chunk (save it as a file to your snippets folder and enable it in Obsidian in the Appeareance menu), you might add aditional filetypes.

div[data-path$='.Rproj']{
	display: none;
}

div[data-path$='.cls']{
	display: none;
}

div[data-path$='.yml']{
	display: none;
}

div[data-path$='.json']{
	display: none;
}

Plugin is a small tweak of a plugin made by deathau: deathau/txt-as-md-obsidian: Edit txt files in Obsidian.md as if they were markdown.

Plugins for better editing experience

• Use obsidian-shellcomands with quarto render {{file_path:absolute}} --to pdf to render the file inside Obsidian. This should work for both qmd and rmd files.
• Use HTML Reader to render HTML output inside Obsidian, Obsidian natively supports pdfs.

To-do

• Creation of new qmd files
• Curly braces {language} treated as language for codeblock
• CSS for callout blocks
• Better integration with Obsidian

Compatibility

The required APIs were only added in Obsidian 0.10.12, and as such, that is the minimum version of Obsidian required to use this plugin.

Installation

From within Obsidian

Currently the plugin is not accesible in the Obsidian Community list. To access and beta test it, you can use the BRAT plugin.

From GitHub

• Download the Latest Release from the Releases section of the GitHub Repository
• Extract the plugin folder from the zip to your vault's plugins folder: <vault>/.obsidian/plugins/ Note: On some machines the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot to show the folder in Finder.
• Reload Obsidian
• If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.

Security

Third-party plugins can access files on your computer, connect to the internet, and even install additional programs.

The source code of this plugin is available on GitHub for you to audit yourself, but installing plugins into Obsidian is currently a matter of trust.

I can assure you here that I do nothing to collect your data, send information to the internet or otherwise do anything nefarious with your system. However, be aware that I could, and you only have my word that I don't.

Development

This project uses Typescript to provide type checking and documentation. The repo depends on the latest plugin API in Typescript Definition format, which contains TSDoc comments describing what it does.

Note: The Obsidian API is still in early alpha and is subject to change at any time!

If you want to contribute to development and/or just customize it with your own tweaks, you can do the following:

• Clone this repo.
• npm i or yarn to install dependencies
• npm run build to compile.
• Copy manifest.json, main.js and styles.css to a subfolder of your plugins folder (e.g, <vault>/.obsidian/plugins/<plugin-name>/)
• Reload obsidian to see changes

Alternately, you can clone the repo directly into your plugins folder and once dependencies are installed use npm run dev to start compilation in watch mode. You may have to reload obsidian (ctrl+R) to see changes.

Pricing

Plugin is completely free, but you might contribute to the author of the orginal plugin (deathau) via the following:

Version History

0.0.1

Initial release by death_md supporting txt!

0.0.2

Repurposing this plugin to viev and edit qmd files, plugin available via BRAT.

0.0.3

Added support for rmd files.