Marp Cli Engine (--engine) with the API (node.js)

[samuele-cozzi]

Hi, I appreciate your wonderful repository.
Does the engine parameter (--engine) get supported by the API (Experimental)? Exist any practical examples?

[yhatt]

Marp CLI API supports any CLI arguments including --engine. (In other words, API does never restrict any CLI options)

import { marpCli } from '@marp-team/marp-cli'

// Specify engine by the module name
marpCli(['--engine', '@marp-team/marp-core', './slide.md'])

// Specify engine by the path for the function engine
marpCli(['--engine', 'engine.mjs', './slide.md'])

[samuele-cozzi]

Hi,

I'm developing obsidian plugin on electron framework. I have tried the first one but without success:

I'm trying the second one but it doesn't work.

Do you have some working examples of this implementation, or do you have any suggestion on this case?

[yhatt]

If specified the module name as --engine option, Marp CLI tries to find out the specified module from node_modules in the current Node.js project. Within Electron-based apps such as Obsidian, it may not work because the project struture is different from general Node.js projects.

So we recommend to use the external script as --engine option in your use case. Actually an another Marp plugin for Obsidian is using this way and working well. engine.mjs may be bundled while building the plugin, so it's important for using the custom engine to keep a splitted Marp engine script file.