search

mars-sim / mars-sim.github.io

Web pages for mars-sim
https://mars-sim.github.io
0 stars 0 forks source link

Use static site generator #5

Open mokun opened 4 days ago

mokun commented 4 days ago

@bevans2000

As a follow-up to the issue at https://github.com/mars-sim/mars-sim/issues/834#issuecomment-2466950350,

May be we can consider using https://github.com/jackyzha0/quartz ?

bevans2000 commented 4 days ago

Interesting, I like https://jekyllrb.com/ because it is already integrated into GitHub Pages and does not need any special tooling on the client. It also supports markdown and html content. I plan to have a play soon.

bevans2000 commented 12 hours ago

@mokun I've played with Jekyll today and splitting up the existing web page content. I've also added one of the generated vehicle spec pages to see how it behaves. It would be possible to generated all the same page set for the website. Structure is great and we could move lots of the main readme file into this as dedicated pages. However the style needs work but it's easy to switch another theme if we find one. https://bevans2000.github.io/

mokun commented 12 hours ago

@mokun I've played with Jekyll today .

Yes Jekyll is quite good for our use already

Structure is great and we could move lots of the main readme file into this as dedicated pages.

Ok. So what do we eventually want to show in readme.md ?

However the style needs work but it's easy to switch another theme if we find one.

Right.

I wonder if jekyll supports responsible web page or not.

https://bevans2000.github.io/

Is it easy to configure git action?

bevans2000 commented 4 hours ago

Yes, this layout is responsive. And it's using the standard GitHub in action.

The readme has a lot of content about the thinking and approach to the simulation and that would be better on a web site. The readme should be focused on developers and a high level overview.