~sircmpwn/git.sr.ht/#80: Show READMEs on repo pages

Status
RESOLVED IMPLEMENTED
Submitter
~sircmpwn
Assigned to
No-one
Submitted
1 year, 4 months ago
Updated
2 months ago
Labels
No labels applied.

~przemoc 1 year, 3 months ago

When you will be implementing it, please consider adding option to render README file as markdown for instance. Some people don't like .md extension (or any other one) and prefer more traditional README filename, even if what's there is actually markdown/commonmark/whatever.

~sircmpwn 1 year, 3 months ago

No, you should name your files correctly. I'm not going to render something that is plaintext as markdown and fuck up their monospaced formatting, and I'm not going to add an option where you can tick my README is markdown in your repo settings. The option already exists, and you turn it on by appending .md to your README's filename.

~przemoc 1 year, 3 months ago

Ok. I thought you'll be a bit more flexible and adhering to people's use cases than GitHub is. And I wasn't asking to treat all README files automatically as markdown, but to have an option where you can change its rendering from plain-text to something else: markdown, scdoc, whatever human-readable format is already used in the README.

~sircmpwn 1 year, 3 months ago

I'm open to supporting many use-cases if I can do them in a broadly applicable way. When you say is I want to have a setting to render my README as markdown no matter what, what I hear is I want a means of using arbitrary markup languages to render my README. This would be difficult to implement securely.

I intend to support niche use-cases by letting you implement them by leveraging the *.sr.ht API. For example, I will allow you to attach arbitrary metadata to git commits that will be displayed on the commit summary page, so you can indicate that it passed a build or whatever.

~przemoc 1 year, 3 months ago

Alternative approach to showing README below main repo view (as GitHub does for instance), would be displaying markdown rendered README.md or plain-text README in separate About tab. It is worth considering option for setting About tab to be the default one showed when visiting the repo (I think I've seen similar solution on BitBucket).

cgit has about-filter and root-readme settings, which are useful.

~sircmpwn 1 year, 3 months ago

Alternative approach to showing README below main repo view (as GitHub does for instance), would be displaying markdown rendered README.md or plain-text README in separate About tab.

This is what I want to do (and this is what cgit does).

~lthms 6 months ago

Hi! ~sircmpwn, is it okay if I dig a bit into that issue, to see if I can propose something, or are you planning to do it yourself?

~sircmpwn 6 months ago

This is blocked by moving to an in-house repo viewer, which would be a lot of work.

~lthms 6 months ago

This is probably not the most “first contribution” friendly issue, then :D. I guess you have works with higher priorities to achieve before this one.

I will probably wander here and there, to find something more accessible. Thanks for your answer.

~sircmpwn 6 months ago

I'm not sure there are many easy things to do for git.sr.ht right now, but you could poke around in the other bug trackers if you're looking for somewhere to help.

~sircmpwn REPORTED IMPLEMENTED 5 months ago

This is implemented in the in-house-viewer branch

~technomancy 2 months ago

Is it intentional that you must capitalize README.md or should it fall back to rendering readme.md if that's not found?

~sircmpwn 2 months ago

This is deliberate, yeah.