oracle/opengrok

Render all markdown files via showdown

Open

#2,777 创建于 2019年5月20日

在 GitHub 查看
 (4 评论) (2 反应) (0 负责人)Java (4,060 star) (747 fork)batch import
UIenhancementhelp wanted

描述

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?

贡献者指南

技术栈
javascriptjavahtml
领域
frontenddocumentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Basic knowledge of JavaScriptFamiliarity with OpenGrok's frontend structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
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.