No local converter option
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 42/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- matlab
- Bereich
- documentation, tooling
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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:
- Install DocMaker v0.8.0 (MATLAB_DocMaker.mltbx from the GitHub release) in MATLAB:
>> matlab.addons.install("MATLAB_DocMaker.mltbx")
- No converter option besides GitHub/GitLab:
>> setenv("DOCMAKER_CONVERTER", "cmark")
>> c = docmaker.converter()
Error using docmaker.converter (line 28)
Unknown converter "cmark".
- Vorherrschende Sprache
- MATLAB
- Sterne
- 10
- Forks
- 3
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus mathworks/docmaker
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Provide a docinit functionaliyEvtl. wieder frei @k-deeley hat das vor 42 Tagen übernommen, und es ist kein Pull Request offen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 48/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 59/100
-
Token bug in converter.mEvtl. vergeben @k-deeley hat das vor 20 Tagen übernommen. Offenbug
Alle Issues in mathworks/docmaker
Ähnliche Issues
-
Request for clarification
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 87/100
UniprJRC/DSwithMATLAB#233 · 1 Kommentar ·
-
keep-for-CCMI-project-students
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 72/100
fitbenchmarking/fitbenchmarking#1834 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 67/100
wissem01chiha/slxio#51 ·
-
census digest: print a denominator for EDGE-FAMILY CARDINALITY VIOLATIONS (did-schema OPEN_WORK #79)OffenV2
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
VH-Lab/DID-matlab#399 ·
Maintainer antworten meist innerhalb von 1 Tag