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

Fix badge links on the website #170

Open
cschwan opened this issue Aug 27, 2022 · 3 comments
Open

Fix badge links on the website #170

cschwan opened this issue Aug 27, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@cschwan
Copy link
Contributor

cschwan commented Aug 27, 2022

Commits 491cf26, 571c463 and a36ce33 tried to make the link point to installation docs to markdown file if viewed on github and to the rendered markdown file if viewed on the website. Unfortunately, the latter doesn't work due to benbalter/jekyll-relative-links#74.

@cschwan cschwan added the documentation Improvements or additions to documentation label Aug 27, 2022
@alecandido
Copy link
Member

I wonder at this point if it's time to drop Ruby and just make a workflow with something else.

Jekyll is nice in GitHub Pages because it's there by default, and you have to do little to nothing to make it working. But it's not the most common choice for static site generators (SSG), and it's harder to find Ruby developers than JS or Python ones (so smaller community, and fewer ready-made solutions).

@cschwan
Copy link
Contributor Author

cschwan commented Aug 27, 2022

For me this bug isn't really a problem. What would you suggest to use instead of Jekyll?

@alecandido
Copy link
Member

The most popular and reliable I believe to be Next.js, another sensible choice in JS is Docusaurus. And just pick a reasonable ready-made theme (with the advantage that we can customize it, if needed).

But we can even avoid JS: being a Rust project in the first place why not mdBook directly? The PineAPPL book :)
(Also Sphinx is suitable, since it's already there for Python, but I'd keep it for Python projects, rather than generic websites)

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

No branches or pull requests

2 participants