oracle/opengrok

Render all markdown files via showdown

Open

#2 777 ouverte le 20 mai 2019

Voir sur GitHub
 (4 commentaires) (2 réactions) (0 assignés)Java (4 060 stars) (747 forks)batch import
UIenhancementhelp wanted

Description

OpenGrok seems to be rendering only markdown file only when listing directories. When I click arbitrary *.md file to see the content, I see source code.

Would it be possible and useful to always render markdown files, for cases like searching / browsing documentation?

Guide contributeur

Stack technique
javascriptjavahtml
Domaine
frontenddocumentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Basic knowledge of JavaScriptFamiliarity with OpenGrok's frontend structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65
Direction de recherche
The issue requests rendering Markdown files using Showdown when browsing documentation. Currently, OpenGrok treats Markdown files as source code. To implement, you would need to modify the file viewing component in the webapp (likely JavaScript). Look at the method that displays file content (e.g., in the 'webapp/js/' directory). Integrate Showdown to detect .md extension and render HTML instead of raw text. Consider configuration option to disable. Also check if backend needs to serve Markdown as plain text. Consult maintainers for preferred approach.