~sircmpwn/sr.ht-discuss

3 3

Render only body of HTML READMEs

Details
Message ID
<87sez21jhj.fsf@gilgamesh.mail-host-address-is-not-set>
DKIM signature
pass
Download raw message
I accidentally posted this report to the wrong mailing list
(~sircmpwn/public-inbox).  Here it is again:

Currently, the sourcehut renders the <head> of HTML READMEs in addition
to the body.

Please see this test repository...

https://git.sr.ht/~breatheoutbreathein/sourcehut-html-readme

...where the <head> content, consisting of <title> and <style> elements,
is erroneously rendered above the first <h1>.

Thanks for all your work on SourceHut!!

Joseph
Details
Message ID
<72b38ae4-250f-4c8b-a894-56e685addd3f@bitfehler.net>
In-Reply-To
<87sez21jhj.fsf@gilgamesh.mail-host-address-is-not-set> (view parent)
DKIM signature
pass
Download raw message
Hey,

On 5/1/24 2:08 AM, Joseph Turner wrote:
> Currently, the sourcehut renders the <head> of HTML READMEs in addition
> to the body.

The README is supposed to be an HTML *snippet*, not an HTML document.

See https://man.sr.ht/git.sr.ht/#setting-a-custom-readme and also the 
example linked there, 
https://git.xenrox.net/~xenrox/custom-readme/tree/master/item/readme.html

Cheers,
Conrad
Details
Message ID
<87r0ekthd3.fsf@breatheoutbreathe.in>
In-Reply-To
<72b38ae4-250f-4c8b-a894-56e685addd3f@bitfehler.net> (view parent)
DKIM signature
pass
Download raw message
Hi Conrad,

Conrad Hoffmann <ch@bitfehler.net> writes:

> Hey,
>
> On 5/1/24 2:08 AM, Joseph Turner wrote:
>> Currently, the sourcehut renders the <head> of HTML READMEs in addition
>> to the body.
>
> The README is supposed to be an HTML *snippet*, not an HTML document.
>
> See https://man.sr.ht/git.sr.ht/#setting-a-custom-readme and also the
> example linked there,
> https://git.xenrox.net/~xenrox/custom-readme/tree/master/item/readme.html

Thanks for the explanation!

For other Org-mode users, the following form will export an Org document
to HTML with only a body:

(org-export-to-file 'html "README.html" nil nil nil t)

Thanks!

Joseph
Details
Message ID
<D0Z8J5N4PLG0.14FO1M1WUQO7C@cepl.eu>
In-Reply-To
<72b38ae4-250f-4c8b-a894-56e685addd3f@bitfehler.net> (view parent)
DKIM signature
pass
Download raw message
On Thu May 2, 2024 at 10:53 AM CEST, Conrad Hoffmann wrote:
> See https://man.sr.ht/git.sr.ht/#setting-a-custom-readme and also the 
> example linked there, 
> https://git.xenrox.net/~xenrox/custom-readme/tree/master/item/readme.html

I still believe that Sourcehut should render at least the most
common other “markdown” formats (e.g., rST, AsciiDoc, and
Org-mode) as well.

Best,

Matěj

-- 
http://matej.ceplovi.cz/blog/, @mcepl@floss.social
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
 
Be pitiful, for every man is fighting a hard battle.
  -- Ian MacLaren, at least 1898
Reply to thread Export thread (mbox)