How does the setup directory in addon work?

[sghuang19]

I saw some addons were using scripts in setup directory. For example, this one: https://github.com/7086cmd/slidev-addon-tikzjax/blob/main/setup/transformers.ts

I tried a similar thing:

import naive from "naive-ui";
import { defineAppSetup } from "@slidev/types";

export default defineAppSetup(({ app }) => {
  app.use(naive);
  console.log("naive-ui setup");
  alert("naive-ui setup");
});

But this wasn't executed -- alert window didn't pop up, nor did I see any console msg.

Under what conditions, will my code in setup directory get executed?

[sghuang19]

@7086cmd Tagging you here since I saw you using defineTransformerSetup.

Another example: https://github.com/KermanX/slidev-addon-python-runner/blob/main/setup/code-runners.ts

[kermanx]

Only code with the exact file name as described in the docs will run (in Node.js or in the browser).

For example, according to https://sli.dev/custom/config-vue, the code you provided must be put inside ./setup/main.ts based on where your slides.md is. Then the code will run in the browser without the need of any extra configuration.