Markdown panel

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

[ulrik]

@Christoph-Hart great news! :)

[d.healey]

I just had a plugin that kept failing the tests in Pluginval, once I removed the markdown panel from my project it passed all tests.

[ulrik]

@d-healey it works fine here, with the au plugins in Logic Pro X
using scriptnode from yesterday

[d.healey]

@ulrik I'm using a VSTi, it crashes Reaper and Pluginval when the markdown panel is present.

[ustk]

@d-healey @Christoph-Hart Same thing here, standalone and plugins are crashing if they contain a Markdown panel.

[ulrik]

@d-healey @ustk I checked with the VSTi version as well, works fine here, are you testing in Windows?
I'm on Mac and both au and vst works fine with the Markdown panel, strange...

[Christoph Hart]

I am currently writing an example project for the docs, then I'll make sure it behaves in all contexts.

It's actually not very surprising that it crashes at initialisation as it builds the database on startup which might interfere with the practice of validation tools that load and destroy instances of a plugin very quickly.

[d.healey]

@Christoph-Hart Bump bump I'm still getting crashes with the markdown panel. Standalone seems to work but VSTi and VST are crashing, I haven't tried AU.