Tooling consideration for docs site

Abierto
#58 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Estancado

Línea de trabajo

No se mencionan archivos del repositorio ni puntos de entrada. Empieza por localizar la configuración actual de dependencias de MkDocs y Material, así como los comandos utilizados para compilar o servir el sitio, y después compara las tres opciones con las indicaciones de migración enlazadas. Se considerará terminado cuando se haya seleccionado y documentado un enfoque, y se haya verificado mediante una compilación exitosa del sitio.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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!

Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
6 d 1 h
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Imageomics/Collaborative-distributed-science-guide

Todos los issues de Imageomics/Collaborative-distributed-science-guide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.