oracle/opengrok

Render all markdown files via showdown

Open

Aperta il 20 mag 2019

Vedi su GitHub
 (4 commenti) (2 reazioni) (0 assegnatari)Java (4060 star) (747 fork)batch import
UIenhancementhelp wanted

Descrizione

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?

Guida contributor

Tech stack
javascriptjavahtml
Dominio
frontenddocumentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Basic knowledge of JavaScriptFamiliarity with OpenGrok's frontend structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65
Direzione di ricerca
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.