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

Convert Jekyll documentation to mkdocs #1811

Open
Benvii opened this issue Dec 17, 2024 · 0 comments · May be fixed by #1813
Open

Convert Jekyll documentation to mkdocs #1811

Benvii opened this issue Dec 17, 2024 · 0 comments · May be fixed by #1813

Comments

@Benvii
Copy link
Member

Benvii commented Dec 17, 2024

Jeckyll documentation is difficult to handle static assets, path differ which makes images not visible when viewing it from any markdown editor. Also it requires ruby which isn't used in this project.

We propose to :

  • Convert the documentation from Jekyll to mkdocs to make it more accessible
  • Add github actions that generate the website, event generate the website by pull requests ..
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

2 participants