HISE Logo Forum
    • Categories
    • Register
    • Login

    Markdown panel

    Scheduled Pinned Locked Moved Scripting
    40 Posts 5 Posters 2.0k Views
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • ulrikU
      ulrik @Christoph Hart
      last edited by

      @Christoph-Hart Wow, beautiful!! :)

      Hise Develop branch
      MacOs 15.3.1, Xcode 16.2
      http://musikboden.se

      1 Reply Last reply Reply Quote 0
      • d.healeyD
        d.healey
        last edited by

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

        Libre Wave - Freedom respecting instruments and effects
        My Patreon - HISE tutorials
        YouTube Channel - Public HISE tutorials

        orangeO ulrikU 2 Replies Last reply Reply Quote 0
        • orangeO
          orange @d.healey
          last edited by

          @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.

          develop Branch / XCode 13.1
          macOS Monterey / M1 Max

          ulrikU d.healeyD 2 Replies Last reply Reply Quote 0
          • ulrikU
            ulrik @orange
            last edited by

            @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:
            Skärmavbild 2019-09-26 kl. 07.19.58.png

            Hise Develop branch
            MacOs 15.3.1, Xcode 16.2
            http://musikboden.se

            orangeO 1 Reply Last reply Reply Quote 0
            • ulrikU
              ulrik @d.healey
              last edited by

              @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.

              Hise Develop branch
              MacOs 15.3.1, Xcode 16.2
              http://musikboden.se

              1 Reply Last reply Reply Quote 0
              • orangeO
                orange @ulrik
                last edited by

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

                Link Preview Image
                HISE | Docs

                favicon

                (docs.hise.audio)

                develop Branch / XCode 13.1
                macOS Monterey / M1 Max

                ustkU 1 Reply Last reply Reply Quote 1
                • ustkU
                  ustk @orange
                  last edited by

                  @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...

                  Can't help pressing F5 in the forum...

                  orangeO 1 Reply Last reply Reply Quote 2
                  • orangeO
                    orange @ustk
                    last edited by orange

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

                    develop Branch / XCode 13.1
                    macOS Monterey / M1 Max

                    ustkU 1 Reply Last reply Reply Quote 0
                    • ustkU
                      ustk @orange
                      last edited by

                      @orange I'm using Hise's integrated tool

                      Can't help pressing F5 in the forum...

                      1 Reply Last reply Reply Quote 0
                      • d.healeyD
                        d.healey @orange
                        last edited by

                        @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.  
                        

                        Libre Wave - Freedom respecting instruments and effects
                        My Patreon - HISE tutorials
                        YouTube Channel - Public HISE tutorials

                        orangeO 1 Reply Last reply Reply Quote 0
                        • orangeO
                          orange @d.healey
                          last edited by 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

                          develop Branch / XCode 13.1
                          macOS Monterey / M1 Max

                          d.healeyD 1 Reply Last reply Reply Quote 1
                          • d.healeyD
                            d.healey @orange
                            last edited by

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

                            Libre Wave - Freedom respecting instruments and effects
                            My Patreon - HISE tutorials
                            YouTube Channel - Public HISE tutorials

                            1 Reply Last reply Reply Quote 1
                            • d.healeyD
                              d.healey
                              last edited by

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

                              Libre Wave - Freedom respecting instruments and effects
                              My Patreon - HISE tutorials
                              YouTube Channel - Public HISE tutorials

                              orangeO 1 Reply Last reply Reply Quote 0
                              • orangeO
                                orange @d.healey
                                last edited by

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

                                develop Branch / XCode 13.1
                                macOS Monterey / M1 Max

                                1 Reply Last reply Reply Quote 1
                                • Christoph HartC
                                  Christoph Hart
                                  last edited by

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

                                  ulrikU 1 Reply Last reply Reply Quote 3
                                  • ulrikU
                                    ulrik @Christoph Hart
                                    last edited by

                                    @Christoph-Hart great news! :)

                                    Hise Develop branch
                                    MacOs 15.3.1, Xcode 16.2
                                    http://musikboden.se

                                    1 Reply Last reply Reply Quote 0
                                    • d.healeyD
                                      d.healey
                                      last edited by

                                      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.

                                      Libre Wave - Freedom respecting instruments and effects
                                      My Patreon - HISE tutorials
                                      YouTube Channel - Public HISE tutorials

                                      ulrikU 1 Reply Last reply Reply Quote 0
                                      • ulrikU
                                        ulrik @d.healey
                                        last edited by ulrik

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

                                        Hise Develop branch
                                        MacOs 15.3.1, Xcode 16.2
                                        http://musikboden.se

                                        d.healeyD 1 Reply Last reply Reply Quote 0
                                        • d.healeyD
                                          d.healey @ulrik
                                          last edited by

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

                                          Libre Wave - Freedom respecting instruments and effects
                                          My Patreon - HISE tutorials
                                          YouTube Channel - Public HISE tutorials

                                          ulrikU 1 Reply Last reply Reply Quote 1
                                          • ustkU
                                            ustk
                                            last edited by

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

                                            Can't help pressing F5 in the forum...

                                            1 Reply Last reply Reply Quote 1
                                            • First post
                                              Last post

                                            23

                                            Online

                                            1.7k

                                            Users

                                            11.8k

                                            Topics

                                            102.6k

                                            Posts