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

Initial oranda setup #5044

Merged
merged 2 commits into from
Jul 7, 2023
Merged

Initial oranda setup #5044

merged 2 commits into from
Jul 7, 2023

Conversation

tertsdiepraam
Copy link
Member

oranda is a new tool by axo, which can generate pretty websites for projects, based on info from Cargo.toml and GitHub. Here is the blog post where they explain it: https://blog.axo.dev/2023/06/oranda.

I think it would be nice to replace this page with the generated website. It contains a link to the docs, funding and changelog. It also renders the mdbook documentation with the same style as the rest of the website. It can also show installation options, but currently, that feature is not yet flexible enough for us. We could open some issues on their repo to discuss what we would need (they're really friendly).

We might need to either clean up the README or make a separate markdown document as landing page to make this even more useful, but I think this is a nice start.

I chose the light theme to start with, but we can customize the CSS any way we want.

You can test the website yourself by installing oranda:

cargo install oranda --locked --profile=dist

and then running it in dev mode in the root of the project:

oranda dev
Click here to see screenshots of the generated website

image
image
image
image

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

GNU testsuite comparison:

Skip an intermittent issue tests/tail-2/inotify-dir-recreate

Copy link
Contributor

@cakebaker cakebaker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good :) A detail: the "contributing"-link is broken.

@tertsdiepraam
Copy link
Member Author

Yeah I noticed that too. I think I'll have to write a separate homepage that's not based on the README to make that work.

@sylvestre sylvestre merged commit 459e4f8 into uutils:main Jul 7, 2023
@sylvestre
Copy link
Contributor

much better, thanks

@sylvestre
Copy link
Contributor

I guess you will have to do something to update ?

https://uutils.github.io/

@tertsdiepraam
Copy link
Member Author

Yes, but like I said in some other issue. I can't work on my laptop at the moment. I'll pick it back up once it's repaired.

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

Successfully merging this pull request may close these issues.

3 participants