from Hacker News

Readme in Static Site (RISS)

by carlesfe on 11/22/21, 9:08 AM with 7 comments

• by captn3m0 on 11/22/21, 1:16 PM

  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/...

• by lifthrasiir on 11/22/21, 10:56 AM

  So it is sort of conitional comments [1] in the olden MSIE! A small but good idea, I like how simple riss.awk is.

  [1] https://en.wikipedia.org/wiki/Conditional_comment

• by southerntofu on 11/22/21, 12:12 PM

  I never really understood the idea to have a separate README and index page. Glad to see i'm not the only one :)