Tooling consideration for docs site

Ouverte
#58 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Refactorisation
Clarté
À clarifier
Activité
À l'abandon

Piste de recherche

Aucun fichier du dépôt ni point d’entrée n’est indiqué. Commencez par localiser la configuration actuelle des dépendances de MkDocs et Material, ainsi que les commandes utilisées pour générer ou servir le site, puis comparez les trois options aux indications de migration liées. Le travail sera considéré comme terminé lorsqu’une approche aura été sélectionnée, documentée et vérifiée par une génération réussie du site.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

question

Building/serving a mkdocs site with Material recently yields message:

 │ ⚠ WARNING – MkDocs 2.0 is incompatible with Material for MkDocs
 │
 │   MkDocs 1.x is unmaintained. We recommend switching to Zensical, our
 │   new static site generator, as soon as possible. We're providing an
 │   analysis of the situation in this article:
 │
 │   https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/

The linked summary page in the warning promotes Zensical as their suggested migration/continuity approach.

Presently, it seems like the following options are on the table for consideration among:

  1. Pin mkdocs and Material dependencies accordingly.
  2. Migrate to Zensical.
  3. Adopt mkdocs 2.0 with another theme.

Currently, I believe starting with 1) and phasing to 2) is reasonable for least friction and ideal long-term support. Discussion welcome!

Langage dominant
Python
Étoiles
1
Forks
1
Merge moyen
6 j 1 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Imageomics/Collaborative-distributed-science-guide

Toutes les issues de Imageomics/Collaborative-distributed-science-guide

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.