~nabijaczleweli/html-readme

ref: 9e3fceab1231c58ee07d5d83e1500f2e8aef4ba7 html-readme/html-readme.md -rw-r--r-- 1.0 KiB
9e3fceabнаб Also link to the source 1 year, 1 month ago

#html-readme(7) -- A demo of deploying a custom HTML README

#DESCRIPTION

By default, {git,hg,hub}.sr.ht use README or README.md as the README; however, by PUTting some text/html at /api/repos/repo-name/readme, any source format can be used – this README is written in ronn(1) and additionally preprocessed.

#FILES

html-readme.md: the ronn(1) source for this README.

.build.yml:

BUILD_YML_PLACEHOLDER

Of note:

  • the secret lands in ~/.readme-token,
  • additional care is taken not to echo it – I'd recommend using a separate token for this purpose to make it easier to revoke if it does get leaked.

#AUTHOR

Written by наб <nabijaczleweli@nabijaczleweli.xyz>

#REPORTING BUGS

<nabijaczleweli@nabijaczleweli.xyz>

#SEE ALSO

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