Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
:and then running it in
dev
mode in the root of the project:Click here to see screenshots of the generated website