Add a website documentation

[pyrech]

Tl;Dr: you can play with the website here atm: https://castor.jolicode.com

Summary

I tested different static website generator (Jekyll, hugo) or saw old ones on github but they were either

• not easy to install/build on GH Pages
• not maintained
• not providing a nice theme
• not adapted for markdown documentation
• in javascript.

I finally give a try to mkdocs and the material theme and it seems perfect for castor documentation website, so here it is 🎉

Featuring:

• slightly improved documentation tree
• statically built (no js) and deploy from a GitHub Action on GitHub Pages
• code coloration and copy widget
• support of GitHub Markdown "alerts" (tips, warning, info, etc)
• search bar (and a S keyboard shortcut) + highlight of matches
• light and dark themes
• links to edit the page on GitHub
• anchors for each title
• mobile friendly
• navigation tree partially generated automatically from the _nav.md file
• list of some real world Castor usage

Preview

A preview is available here: https://castor.jolicode.com

Screenshots

Homepage

---

Getting started - scrolled down

---

Search + highlight

---

Examples + dark mode

Todo

• Squash the commits
• Setup GitHub Pages
• Setup the custom domain name
• Setup redirection.io hosted instance
• Crawl with redirection.io to ensure there is no 404

[lyrixx]

nice !

[lyrixx]

hello my old friend 😬

[lyrixx]

Nice (except the branch to remove in GHA config)