Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use static site generator #5

Closed
mokun opened this issue Nov 13, 2024 · 6 comments
Closed

Use static site generator #5

mokun opened this issue Nov 13, 2024 · 6 comments

Comments

@mokun
Copy link
Member

mokun commented Nov 13, 2024

@bevans2000

As a follow-up to the issue at mars-sim/mars-sim#834 (comment),

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

@bevans2000
Copy link
Member

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
Copy link
Member

@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
Copy link
Member Author

mokun commented Nov 16, 2024

@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 responsive web page or not.

https://bevans2000.github.io/

Is it easy to configure git action?

@bevans2000
Copy link
Member

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.

@bevans2000
Copy link
Member

@mokun I have done more reworking of prototype of the new web site; https://bevans2000.github.io/
I have now improved how the configuration entities are generated including the addition of ConstructionStage & ResupplyManifest.

@mokun
Copy link
Member Author

mokun commented Dec 1, 2024

eworking of prototype of the new web site; https://bevans2000.github.io/

That's awesome.

I can see you have added a dozen of those "Simulation Entities" so far. They look good.

We'll update all screenshots in near future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants