Возможность указать дату сборки документации

Abierto
#2,000 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript

Línea de trabajo

Comienza rastreando cómo se gestionan los valores de presets.yaml y la opción mtimes durante la compilación de la documentación, incluida la ruta de la extensión github-vcs. Compara esos puntos de entrada con la generación de PDF y determina dónde podría exponerse un valor durante la compilación; se considera terminado cuando la interfaz elegida inserta la fecha de compilación actual en el documento y se actualiza en cada recompilación.

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

Descripción

enhancement from_support
Какую проблему решит эта функция?/What is the problem this?

Сейчас нет штатного способа вывести в самом документе дату его сборки. Это особенно нужно на титульных страницах PDF, где дата должна автоматически обновляться при каждой пересборке.

Какую функцию вы предлагаете для решения этой проблемы?/What is the feature you are proposing to solve the problem?

Добавить штатный способ получить дату сборки прямо в документе — либо флаг сборки, который сам проставит дату в нужное место, либо встроенную переменную (например {{ buildDate }}), которую платформа автоматически заполняет временем сборки.

Какие альтернативы вы рассматривали?/What alternatives have you considered?
  • переменная через presets.yaml — работает, но дату приходится генерировать внешним скриптом перед сборкой или вручную указывать в файле.

  • mtimes: true — даёт дату последнего коммита файла (а не сборки), требует git + расширение github-vcs и в PDF вообще не выводится.

Lenguaje dominante
TypeScript
Estrellas
123
Forks
52
Merge medio
2 d 18 h
PR fusionados (30 d)
21

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 diplodoc-platform/cli

Todos los issues de diplodoc-platform/cli

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.