search

nobiot / md-roam

Use Org-roam with markdown files by adding Md-roam as a plug-in. Mix org and markdown files in a single Org-roam database.
GNU General Public License v3.0
333 stars 15 forks source link

Markdown files with a ".qmd" extension don't render properly in org-roam-ui, but those with ".md" do #86

Open TS-CUBED opened 6 months ago

TS-CUBED commented 6 months ago

Hello, first of all: thanks for the great work integrating markdown files in org-roam. Really useful, since I cannot use only org in my work at uni.

I use Quarto to write some things (with embedded active code, and for publication as HTML and for lecture notes), and sometimes I need to use that format for my notes as well.

My setup includes:

(setq org-roam-file-extensions '("org" "md" "qmd")) 
(setq md-roam-file-extension '("md" "qmd"))

which works and I can create markdown files in both formats - with all the links, backlinks, etc. working between plain markdown, quarto, and org files. All of these also show up in org-roam-ui, with all links in place (and even nodes for the references).

The only niggle is with the org-roam-ui preview, which does not work for .qmd files, even though the same file with .md renders nicely.

The markdown file ...test_md.md:

---
title: Test MD
id: 2024-05-10T132302
---

# Just a test heading

And some test text

renders as:

image

with a good preview of the markdown as it would be rendered as HTML.

The quarto file ...test_qmd.qmd:

---
title: Test QMD
id: 2024-05-10T131413
---

# Just a test heading

And some test text

renders as:

image

which does not parse the YAML header and omits the first heading.

As you can see the files are identical aside from the Q and the file ending. I assume that's a recognition issue on org-roam-ui side, so not sure if it belongs there or here.

nobiot commented 6 months ago

I think you will need to raise an issue in the org-roam-ui project, then?

Also, I don't know why (setq md-roam-file-extension '("md" "qmd")) works. This variable is designed to be a single value, not a list.

As this repo is my personal tool, I don't think I can help you much further. I don't use qml, myself.

TS-CUBED commented 6 months ago

Funny, you added that (list for file extensions) in issue #75

https://github.com/nobiot/md-roam/issues/75

I will raise the issue in org-roam-ui, then.

nobiot commented 6 months ago

Oh thanks for reminding this. Glad it works. Perhaps this part is not considered in org-roam-ui. Perhaps you can try with only setting qmd and see how it behaves.

TS-CUBED commented 6 months ago

Nope, same behaviour with

(setq md-roam-file-extension "qmd")