~sircmpwn/sr.ht-discuss

3 3

using README.rst as the project summary

Details
Message ID
<9f02ea63-9b40-ca36-5cdf-fa53eb22fda3@smoha.org>
DKIM signature
pass
Download raw message
Hi,

Is there a way to set README.rst as the project summary? I have set 
README as the project summary but it seems that Sourcehut cannot render 
the .rst file.

If we can only set README.md as the project summary, I suppose it's 
better if we clarify it by changing the wording from README to README.md

Thanks, Salman
Details
Message ID
<CDJ0GDQZABJQ.3SP069A1BSOSQ@taiga>
In-Reply-To
<9f02ea63-9b40-ca36-5cdf-fa53eb22fda3@smoha.org> (view parent)
DKIM signature
fail
Download raw message
DKIM signature: fail
No, Markdown is the only supported format.
Details
Message ID
<20210814143342.4gontmmgpalgpqkb@prancingpony>
In-Reply-To
<CDJ0GDQZABJQ.3SP069A1BSOSQ@taiga> (view parent)
DKIM signature
missing
Download raw message
On 21/08/14 08:10, Drew DeVault wrote:
> No, Markdown is the only supported format.

Plain text is as well. I'm using it for most of my repositories.
Details
Message ID
<4fa58df3-2d58-d170-6b8c-f8615730acde@archlinux.org>
In-Reply-To
<9f02ea63-9b40-ca36-5cdf-fa53eb22fda3@smoha.org> (view parent)
DKIM signature
pass
Download raw message
On 8/13/21 6:32 PM, Salman Mohammadi wrote:
> Hi,
> 
> Is there a way to set README.rst as the project summary? I have set
> README as the project summary but it seems that Sourcehut cannot render
> the .rst file.
> 
> If we can only set README.md as the project summary, I suppose it's
> better if we clarify it by changing the wording from README to README.md


https://man.sr.ht/git.sr.ht/#setting-a-custom-readme

The hub is thematically the same, in that it only supports plain text
and interpreted markdown, and official policy is "sourcehut will never
add support for additional rendering formats" -- this is in fact why the
API supports uploading your own generated HTML snippets, IIRC.

In other words, if you want to use README.rst, you'll need to do extra
work to have it rendered on git.sr.ht, never mind the project hub. But,
the work is doable.

Since git supports uploading one via the API, it might be nice if the
hub did too... and in fact it does, since before checking for a readme
file from the "summary repo", it first checks for and uses a custom
readme returned by the git.sr.ht API.

See e.g. hubsrht/services.py get_readme() and try_html_readme()

-- 
Eli Schwartz
Arch Linux Bug Wrangler and Trusted User
Reply to thread Export thread (mbox)