oracle/opengrok

Markdown relative links are broken

Open

#2,775 opened on May 20, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (747 forks)batch import
UIbughelp wanted

Repository metrics

Stars
 (4,060 stars)
PR merge metrics
 (Avg merge 1d 22h) (17 merged PRs in 30d)

Description

Opengrok shows markdown README.md content, but if it contains relative links to other markdown files (such as browsing documentation), those links are not working.

At demo site for showdown (library used by opengrok), relative links do work for version 1.8.4 which is currently used but no in opengrok. http://demo.showdownjs.com/

Contributor guide

Research direction
Investigate how OpenGrok renders markdown files, likely using the showdown library. Compare the showdown configuration used by OpenGrok with the demo site that works. Check the webapp directory for markdown rendering code, possibly in a JavaScript file. Consider updating the showdown version or adjusting its options to enable relative links.
Tech stack
javascript
Domain
frontenddocumentation
Issue type
Bug
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic markdown knowledgefamiliarity with OpenGrok UI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60