Markdown Panel is Blank in Exported VST

[Dan Korneff]

Gonna give this a bump.
Right clicking on the markdown panel and selecting Export doesn't seem to create any files.
Is anyone successfully implementing the markdown panel in a plugin?

I've read the documentation, but the link to show how to compile your markdown files is incomplete:
https://docs.hise.audio/working-with-hise/project-management/documentation/project-documentation.html

HISE | UI Components | MarkdownPanel

Embed a full-fledged markdown documentation system.

(docs.hise.audio)

Compile the documentation
If you're done with the documentation, you will need to "compile" it into two files as described here . Right click on the MarkdownPanel and select Export , then run the "Update local cache file" function in the popup window.

[d.healey]

Last time I used the markdown panel I found lots of bugs

[Dan Korneff]

@d-healey Interesting...
On my Win10 machine, it placed the files in:

C:\Users\"USER"\AppData\Roaming\"Company"\"Plugin"\Documentation

[Dan Korneff]

@Christoph-Hart Can you take a look at the markdown panel (or point me in the right direction)?
Exporting a Markdown panel that contains an image does not create an image.dat file, but exporting a panel without images does.

[Dan Korneff]

@Christoph-Hart Any chance you have a sec to peek this out?

[Dan Korneff]

Looks like I got this to work. Markdown only seems to accept .jpg images. PNG will not export.

[ustk]

Necroing this old post because I can't seem to export the doc. When exporting Hise says "Cache was updated" but there are no .dat files in the project directory.

In the end, I am looking for placing my doc online. Is this functionality finally implemented? Is anyone able to make it to work?

[d.healey]

@ustk Does your plugin open in a DAW with the markdown panel? Mine always gets blacklisted so I've stopped using the markdown panel.

[ustk]

@d-healey First I forgot the dat. files were actually exported to the AppData directory so it's fine.

As for the plugin blacklist thing, this is very annoying news! I hope this might be fixed! @Christoph-Hart?

My actual project is an app so not much of a problem for now but it does not smell good for the future...

And did the server sync ever work?

[Dan Korneff]

@d-healey I'm using markdown for my built-in plugin manual. No issues here

[ustk]

@Christoph-Hart Could you just please tell me if I can continue to dig in the StartURL / ServerUpdateURL direction?
It seems to be implemented in the source but I can't get it to work...

• When pointing StartURL to the website, it automatically opens up in the browser when recompiling or running the binary which is very annoying
• I tried placing the .dat/.json files on the server with no luck, the markdown panel stays empty

So is it possible to finally get something out of it?

[ustk]

Finally got it to work!

So the process is:

• Place your .dat and .json on the server inside a folder called "cache"
• In the markdown panel Data, don't use the StartURL property. Instead, place the full URL in ServerUpdateURL but without /cache folder (so something like https://www.mywebsite.com/doc/ , not https://www.mywebsite.com/doc/cache/)

When the binary is launched, the doc will be downloaded from the server

However, there are still a few little bugs:

• If you update the doc on the server, it will be updated at the next init in the AppData as it should, but the doc won't refresh until restarting a 2nd time (might be the index that doesn't rebuild)
• The "Update documentation" button doesn't work in binary
• The hamburger button to show/hide the TOC is invisible (but clicking works, so it might just be that the path isn't embedded)