Using the markdown FT

[d.healey]

I'm slightly confused about this part of the documentation tutorial

An embedded documentation is nice, but you probably also want some sort of online manual so that users without internet connection (or possible customers who want to check out your software) can also read your documentation.

If the user doesn't have internet how can they access the online manual? And how did they download my plugin :p

[ustk]

@d-healey That's actually useful when you want the doc as bedside book.
@Christoph-Hart Is there a way to create a PDF from the .md file?

[d.healey]

@ustk Yeah but it says for an online manual when the user is without internet connection. Does it mean you can create an online version which the user can then download and have as an offline version? And if this is the case can't they access the offline version inside the plugin anyway.

Something like this to convert to PDF - https://www.markdowntopdf.com/

[Christoph Hart]

No I meant if the user doesn't have internet on the system where he runs the plugin which happens more often than you would think, some people are really paranoid about their studio computers.

In this case he can still read the docs on his iPad or whatever device he has internet access to :)

I really despise PDFs as user manual. They never fit the aspect ratio of the screen and their ridiculous page layout distracts the reading process. As if anyone would ever print that LOL.

[d.healey]

@Christoph-Hart I get it now, thanks :)

[ustk]

@Christoph-Hart I get you for the PDF, but some people (like me ) like to keep all the manuals in one place like iBook or anything else in PDF form. But as we can convert the markdown to PDF, it's a good option to have on top of the online version for users...

[d.healey]

What's the method to escape special characters in HISE markdown? For example * and #

[Christoph Hart]

Hmm, good point. Normally I wrap them into a code block like * this!=[]. Is there a Markdown standard for escape characters?

[d.healey]

Depends on the standard. Github uses backslashes, I've seen others use < or > and reference to using |

[ustk]

@d-healey said in Using the markdown FT:

What's the method to escape special characters in HISE markdown? For example * and #

@Christoph-Hart Any news on this?

Also, @ulrik shows above that we can have tree menus in the TOC, but I can only get one level, not two, no matter how many # I use...

[ustk]

Ok so I managed to find a solution by placing different .md in separate folders.

Although the only way I found to get them in a logical order is adding a number in front of the keywords.
Is there a more elegant way to class them without adding numbers?

[ulrik]

@ustk if I remember you can set an index for every .md, to sort, like

[ustk]

@ulrik Oh cool! Checking asap ;)

[d.healey]

Use the documentation tutorial as a template, it has everything you need, including a tutorial :p

GitHub - christophhart/hise_tutorial: The Tutorial project for HISE

The Tutorial project for HISE. Contribute to christophhart/hise_tutorial development by creating an account on GitHub.

GitHub (github.com)

[ustk]

@d-healey Oh! How could I miss it...

[ustk]

@d-healey Thanks, David! I learned a lot ;)

[Jay]

@ulrik any example of this?

[d.healey]

@Jay Look at my last reply.

[Jay]

@d-healey I look but I don't see it

[ulrik]

@Jay it's called "DocumentationTutorial", here https://github.com/christophhart/hise_tutorial/tree/master/DocumentationTutorial

Download it and open it in Hise and you will get a lot of information from it