No local converter option

オープン
  • 何か問題がありますか？
#36 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@k-deeley がすでに取り組んでいます。

2026年10月27日 から。

  • #37 @k-deeley による — オープン

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
matlab
領域
documentation, tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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".
主要言語
MATLAB
スター
10
フォーク
3
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

mathworks/docmaker のほかの issue

mathworks/docmaker の issue をすべて見る

似ている issue

MATLAB の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。