New documentation site #355
stelgenhof
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The current documentation site is built with Jigsaw and Tailwind CSS, hosted on Netlify. Although this has been working great over the years, I wanted to make the entire process more automatic and with less moving parts.
In the last few months, I have been working on an alternative documentation site using Material for MkDocs and all hosted with GitHub pages. Material for MkDocs is a great tool to make a really professional and user friendly documentation site quickly. And with GitHub pages, it makes a great team to build and deploy a documentation site fast and automatic. I still ported some of the code that helps with generating some of the content, to make it all a real complete and automatic solution.
A preview of the new documentation site can be found here: https://azuyalabs.github.io/yasumi-docs/about.html with the content and scripts for the documentation hosted here: https://github.com/azuyalabs/yasumi-docs
There are still things left to do, such as (amongst others):
Let me know what you think, and love to hear any comments or suggestions to make it better.
Cheers! Sacha
Beta Was this translation helpful? Give feedback.
All reactions