oracle/opengrok

Render all markdown files via showdown

Open

#2777 opened on May 20, 2019

View on GitHub
 (4 comments) (2 reactions) (0 assignees)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?

Contributor guide

Tech stack
javascriptjavahtml
Domain
frontenddocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of JavaScriptFamiliarity with OpenGrok's frontend structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.