Open effigies opened 1 year ago
Probably fine to skip README.rst. It doesn't look like there's a maintained Javascript implementation of RST, and it may not be worth calling out to Python just to get a tiny corner case.
We can only really display the raw file for RST since this is rendered in browser.
Edited to propose putting both .txt and .rst in <pre>
tags.
Is your feature request related to a problem? Please describe.
BIDS states:
Currently OpenNeuro only recognizes READMEs at
/README
, soREADME.txt
does not get rendered. Note also that a number ofREADME.txt
files are not written in Markdown, so rendering can lead to some ugly results when people use hash marks in a way inconsistent with Markdown headers.Describe the solution you'd like
Detect the extension and use an appropriate renderer. Allow in-line editing to modify the discovered file, and not always
README
.README
/README.md
README.txt
/README.rst
<pre></pre>
Describe alternatives you've considered
Probably fine to skip
README.rst
. It doesn't look like there's a maintained Javascript implementation of RST, and it may not be worth calling out to Python just to get a tiny corner case.