Readme in Static Site (RISS)

Re:Readme in Static Site (RISS) by captn3m0 on Monday November 22, 2021 @08:16AM (#29305990)

This is neat. Another option is to just ask GitHub to render your README:

    curl  -H "Accept:application/vnd.github.v3.html"  https://api.github.com/repos/captn3m0/hackertray/readme

If your repo is public, you can do this in the browser as well with a single line of jQuery[0] without any authentication. On my blog, the page itself[1] is just a placeholder for the repo URL, and the layout[2] does the rest. Obviously, this isn't static so all the usual caveats apply (SEO/perf/accessibility).

[0]: https://github.com/captn3m0/captn3m0.github.com/blob/master/...

[1]: https://github.com/captn3m0/captn3m0.github.com/blob/master/...

[2]: https://github.com/captn3m0/captn3m0.github.com/blob/master/...

[ Parent | on HN ]

Re:Readme in Static Site (RISS) by tyingq on Monday November 22, 2021 @08:26AM (#29306065)

More on what github does with passed "Accept:" media types here:

https://docs.github.com/en/rest/overview/media-types

[ Parent | on HN ]

Re:Readme in Static Site (RISS) by vhodges on Monday November 22, 2021 @10:39AM (#29307528)

Also for a public repo sticherd[0] (Disclaimer: I am the author) can pull the content from github and inject it onto the page server side. Also not static, but has caching and no need for JS.

Soupault or even Hugo can pull remote content as well.

  [0] https://stitcherd.vhodges.dev/ && https://github.com/vhodges/stitcherd

[ Parent | on HN ]

Re:Readme in Static Site (RISS) by c_joly on Tuesday November 23, 2021 @03:28AM (#29315752)

That's an interesting project, I'll add it to the readme of Riss.

[ Parent | on HN ]

Re:Readme in Static Site (RISS) by vhodges on Tuesday November 23, 2021 @09:48PM (#29326461)

Thanks! I haven't had much time to work on it lately but I have a use for it at $DAYJOB so hopefully I can get back to it at some point.

[ Parent | on HN ]