Forum

    • Register
    • Login
    • Search
    • Categories

    Markdown panel

    Scripting Forum
    5
    40
    577
    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.
    • d.healey
      d.healey last edited by

      Looks cool, tell me more...

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

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

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

        orange 1 Reply Last reply Reply Quote 5
        • orange
          orange @Christoph Hart last edited by 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 😉

          develop Branch / XCode 13.1
          macOS Monterey / M1 Max

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

            @orange said in Markdown panel:

            in normal way

            What's the normal way?

            orange 1 Reply Last reply Reply Quote 0
            • orange
              orange @Christoph Hart last edited by

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

              develop Branch / XCode 13.1
              macOS Monterey / M1 Max

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

                And did you enter the text in a label?

                orange 1 Reply Last reply Reply Quote 0
                • orange
                  orange @Christoph Hart last edited by orange

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

                  develop Branch / XCode 13.1
                  macOS Monterey / M1 Max

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

                    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?

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

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

                      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.

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

                        There you go:

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

                        d.healey orange ulrik 3 Replies Last reply Reply Quote 3
                        • d.healey
                          d.healey @Christoph Hart last edited by

                          @Christoph-Hart Excellent! Thank you!

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

                          1 Reply Last reply Reply Quote 0
                          • orange
                            orange @Christoph Hart last edited by

                            @Christoph-Hart Game changing feature! Thank you!

                            develop Branch / XCode 13.1
                            macOS Monterey / M1 Max

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

                              @Christoph-Hart Wow, beautiful!! 🙂

                              Hise Develop branch
                              MacOs 13, Xcode 14.0.1
                              http://musikboden.se

                              1 Reply Last reply Reply Quote 0
                              • d.healey
                                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

                                orange ulrik 2 Replies Last reply Reply Quote 0
                                • orange
                                  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

                                  ulrik d.healey 2 Replies Last reply Reply Quote 0
                                  • ulrik
                                    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 13, Xcode 14.0.1
                                    http://musikboden.se

                                    orange 1 Reply Last reply Reply Quote 0
                                    • ulrik
                                      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 13, Xcode 14.0.1
                                      http://musikboden.se

                                      1 Reply Last reply Reply Quote 0
                                      • orange
                                        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 )
                                        

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

                                        develop Branch / XCode 13.1
                                        macOS Monterey / M1 Max

                                        ustk 1 Reply Last reply Reply Quote 1
                                        • ustk
                                          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...

                                          I cannot help pressing F5 in the forum...
                                          Studio427 Audio - Audio Instruments & FX Plugins for music production. Website - Facebook

                                          orange 1 Reply Last reply Reply Quote 2
                                          • orange
                                            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

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

                                            33
                                            Online

                                            999
                                            Users

                                            6.6k
                                            Topics

                                            60.9k
                                            Posts