No local converter option

Abierto
  • ¿Algo no está bien?
#36 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@k-deeley ya está trabajando en esto.

Desde el 27/10/2026.

  • #37 de @k-deeley — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
matlab
Área
documentation, tooling

Línea de trabajo

Read tbx/docmaker/docconvert.m around lines 319–328 and inspect the linked feature/local-cmark-converter branch in Nick’s fork to understand the proposed converter and LaTeX post-processing issue. Check how the existing GitHub and GitLab converters are selected and tested. Done means a local cmark-based converter works in CI without remote API tokens and custom MarkdownConverter subclasses pass LaTeX post-processing.

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

Descripción

enhancement

The only two converters are GitHub and GitLab, both requiring a remote API call. For CI environments where tokens are hard to provision (e.g., CI_JOB_TOKEN doesn't have API scope for GitLab), a local cmark-based converter would be really useful. Also, docconvert.m line 319-328 hardcodes a switch on the converter class name, so custom subclasses of MarkdownConverter would fail at the LaTeX post-processing step.

I noticed Nick has a LocalCmark converter on the feature/local-cmark-converter branch in his fork that uses cmark-gfm locally, no network or tokens needed. That would solve the CI problem nicely. Any thoughts on if DocMaker could support this?

Reproduction Steps:
  1. Install DocMaker v0.8.0 (MATLAB_DocMaker.mltbx from the GitHub release) in MATLAB:
>> matlab.addons.install("MATLAB_DocMaker.mltbx")
  1. No converter option besides GitHub/GitLab:
>> setenv("DOCMAKER_CONVERTER", "cmark")
>> c = docmaker.converter()
Error using docmaker.converter (line 28)
Unknown converter "cmark".
Lenguaje dominante
MATLAB
Estrellas
10
Forks
3
Sin PR fusionados en 30 d

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 mathworks/docmaker

Todos los issues de mathworks/docmaker

Issues similares

Más issues de MATLAB

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.