Uploaded image for project: 'Qt Quality Assurance Infrastructure'
  1. Qt Quality Assurance Infrastructure
  2. QTQAINFRA-3390

Render markdown files in html instead of showing raw source on code.qt.io

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • Not Evaluated
    • None
    • None
    • qt-project.org systems
    • None

    Description

      We have multiple markdown formatted files in our repositories, e.g. Qt Creator's readme: https://code.qt.io/cgit/qt-creator/qt-creator.git/tree/README.md

      and Qt Creator's change log files: https://code.qt.io/cgit/qt-creator/qt-creator.git/tree/dist/changes-4.11.0.md

      I also link the changes file from blog posts, so it would be much nicer if this was rendered.
      I don't necessarily want to link to https://github.com/qt-creator/qt-creator/blob/master/dist/changes-4.11.0.md instead

      I don't know much about cgit, but it looks to me like cgit ships with this functionality in principle: https://git.zx2c4.com/cgit/tree/filters/html-converters/md2html

      Attachments

        Issue Links

          is duplicated by

          Bug - A problem which impairs or prevents the functions of the product. QTQAINFRA-3392 Investigate if possible to add markdown rending to code.qt.io for READM.md files

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed
          relates to

          Technical task - A technical task. QTBUG-90235 Create a way to publish release notes

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-90232 Updated release note process

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              anleman Andrey Leman
              con Eike Ziller
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes