oracle/opengrok

Render all markdown files via showdown

Open

#2.777 aberto em 20 de mai. de 2019

Ver no GitHub
 (4 comments) (2 reactions) (0 assignees)Java (747 forks)batch import
UIenhancementhelp wanted

Métricas do repositório

Stars
 (4.060 stars)
Métricas de merge de PR
 (Mesclagem média 2d 13h) (24 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
A issue solicita a renderização de arquivos Markdown usando Showdown ao navegar pela documentação. Atualmente, o OpenGrok trata arquivos Markdown como código fonte. Para implementar, você precisará modificar o componente de visualização de arquivos no webapp (provavelmente JavaScript). Examine o método que exibe o conteúdo do arquivo (por exemplo, no diretório 'webapp/js/'). Integre o Showdown para detectar a extensão .md e renderizar HTML em vez de texto bruto. Considere uma opção de configuração para desativar. Verifique também se o backend precisa servir Markdown como texto simples. Consulte os mantenedores para a abordagem preferida.
Pilha de tecnologia
javascriptjavahtml
Domain
frontenddocumentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Basic knowledge of JavaScriptFamiliarity with OpenGrok's frontend structure
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65