Markdown panel

[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:

HISE | Docs

(docs.hise.audio)

[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 )

HISE | Docs

(docs.hise.audio)

[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?

[ustk]

@orange I'm using Hise's integrated tool

[d.healey]

@orange said in Markdown panel:

@d-healey I tried with readme.md file of the Hise, it works here.

What's that core2 website about?

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

I'm using one that was generated by the markdown editor. This is all it has inside

---
keywords: Documentation
summary:  New file
author:   Christoph Hart
modified: 26.09.2019
---
  
![warning](/images/icon_warning:64px)  
> Oops, this document has not been created yet. Luckily, you can help out. If you want to learn how to contribute to the documentation, please visit [this site](glossary/contributing#contributing) to learn more.  

[orange]

@d-healey

@d-healey said in Markdown panel:

@orange said in Markdown panel:

@d-healey I tried with readme.md file of the Hise, it works here.

What's that core2 website about?

I didn't put this link, I think it's been auto generated by this website when someone writes "readme dot md". The same thing with your post up there :)

Here is the sample project for Markdown Panel:

Markdown_Project.zip

[d.healey]

@orange Thanks, that readme.md file shows up for me. :)

[d.healey]

I'm not seeing anything in the TOC, does this only show up after compiling/exporting the docs?

[orange]

@d-healey Yeah TOC doesn't work for me too. I didn't try compiling, but I think it will be the same.

[Christoph Hart]

I think the best way to answer all this is to make a example repository with a demo documentation that shows all features.

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.

Yes, this is currently not possible, but I'll add this. In the HISE docs it works because the first level of TOC is hardcoded.

Also to have different colours for each tab and its siblings?

Yes, I have that on my list already - currently the root overwrites all child colours, which prevents the individual colouring, but this will be solved automatically when there are multiple root entries :)