Markdown panel

[d.healey]

Looks cool, tell me more...

[Christoph Hart]

powers the entire upcoming doc system, can be used in compiled plugins to display in-built docs

[orange]

@Christoph-Hart Great option!

I put built in documentation in our latest plugin Need 31102, in normal way, it is a little bit time consuming if your documentation has large subjects.

But I think Markdown Panel will make this procedure much more easier

[Christoph Hart]

@orange said in Markdown panel:

in normal way

What's the normal way?

[orange]

@Christoph-Hart I put panels one by one for each subject. And each one closed with it's own buttons.... etc.

[Christoph Hart]

And did you enter the text in a label?

[orange]

@Christoph-Hart Yeah. All of the typography is in the panels

[d.healey]

Any more info on how we can use this in our plugins? Is it possible to setup an F1 hotkey when the plugin has focus to open documentation?

[Christoph Hart]

I need to clean up the code for it before you can use it properly in the compiled plugin, but I wouldn‘t count on F1 not being used by the DAW to show help - after all you just need to make a floating tile visible so I would recommend a button for it.

[Christoph Hart]

There you go:

https://docs.hise.audio/working-with-hise/project-management/documentation/index.html

[d.healey]

@Christoph-Hart Excellent! Thank you!

[orange]

@Christoph-Hart Game changing feature! Thank you!

[ulrik]

@Christoph-Hart Wow, beautiful!!

[d.healey]

I have a readme.md file in the documentation folder but the markdown panel on my UI is just showing Can't resolve link /

[orange]

@d-healey I tried with readme.md file of the Hise, it works here. Also I converted a .doc file to .md with Word, it also works.

I think the .md file that you're using might be problem.

[ulrik]

@orange are you able to create a tab at the same level as the "readme.md" file?

I've tried a lot of times but I can not find the right way to do it.
Also to have different colours for each tab and its siblings?

I want it to look as the Hise documentation does, like this:

[ulrik]

@d-healey did you create the readme.md file using the markdown editor?
It's working here, as soon as the readme.md is created with the editor, it shows up in the markdown floating tile and the "Can't resolve link /" disappear.

[orange]

@ulrik I haven't dig in Markdown Panel stuff deeply yet.

But here in the "Headline" section, there is an explanation to make TOC (table of contents)

All Headlines up to level 2 will create a item in the TOC and in the search box that can be linked to using the anchor syntax (#headline-urlified )

https://docs.hise.audio/working-with-hise/project-management/documentation/markdown.html

[ustk]

@orange @ulrik I have the same "problem" here. In fact, I think it is one .md file per main entry in the menu, so the headlines up to level 2 are lying inside each of these main entries...
I'll give it a go sometimes today...

[orange]

@ustk Are you using Hise's "Markdown Editor" or an external editor for editing .md files?