Generate static site from README.md

[stefanbringuier]

Since the README is has a good amount of content, I had the idea to parse the README into separate markdown files and then generate a static site using mkdocs. At the moment I have a working prototype:

https://stefanbringuier.github.io/awesome-self-driving-labs

The parsing is fairly fragile but does get 90% there. The github action was also modified to run and deploy the site.

Of course other static site generators can be used if there is a desired look and feel.

Its just an idea to make navigation a bit more easy, but maybe deviates from the spirit of awesome lists?

[sgbaird]

I like it! I'll have to take a closer look, but overall I think it makes for a nicer navigation experience. Since the content (and PRs) would still live on the proper awesome list repo, I don't see it as an issue as long as it's clear how to make contributions.

…

________________________________ From: Stefan Bringuier ***@***.***> Sent: Thursday, April 11, 2024 1:00 PM To: AccelerationConsortium/awesome-self-driving-labs ***@***.***> Cc: Subscribed ***@***.***> Subject: [AccelerationConsortium/awesome-self-driving-labs] Generate static site from README.md (Discussion #52) Since the README is has a good amount of content, I had the idea to parse the README into separate markdown files and then generate a static site using mkdocs<https://www.mkdocs.org/>. At the moment I have a working prototype: https://stefanbringuier.github.io/awesome-self-driving-labs The parsing<https://github.com/stefanbringuier/awesome-self-driving-labs/blob/bb76b62b8d17e7e708fc25f081045d80370ec15a/site/parse.py> is fairly fragile but does get 90% there. The github action<https://github.com/stefanbringuier/awesome-self-driving-labs/blob/bb76b62b8d17e7e708fc25f081045d80370ec15a/.github/workflows/references_deploy_site.yml> was also modified to run and deploy the site. Of course other static site generators can be used if there is a desired look and feel. Its just an idea to make navigation a bit more easy, but maybe deviates from the spirit of awesome lists? — Reply to this email directly, view it on GitHub<#52>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AK25ABOFUA5L7WJFOO5MHZTY426T7AVCNFSM6AAAAABGCVNKACVHI2DSMVQWIX3LMV43ERDJONRXK43TNFXW4OZWGQ4TEMZUHE>. You are receiving this because you are subscribed to this thread.