alisw / alibuild

A simple build tool for ALICE software
http://alisw.github.io/alibuild/
GNU General Public License v3.0
24 stars 46 forks source link

Migrate to mkdocs #851

Closed singiamtel closed 4 months ago

singiamtel commented 4 months ago

Reopening this PR


Currently running on http://ali-ci-desktop.cern.ch/

Migrate from Jekyll to mkdocs. The main feature we want from mkdocs is the search bar

I've tried to keep all the old links working, but there may be some that are broken. If you find any, please let me know.

The style is from https://config.docs.cern.ch/

To try it, install the dependencies and run mkdocs serve

# dependencies
pip install mkdocs mkdocs-material mkdocs-markdownextradata-plugin mkdocs-redirects
singiamtel commented 4 months ago

I've been trying other themes but they don't look great. We can change the colorscheme/inject CSS to this one if you don't like something about it (https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#configuration)

singiamtel commented 4 months ago

About the search functionality, it's all done client side, no need to host it on our own infra (search_index.json)