prism: we need both dvc and mlem highlighters

[jorgeorpinel]

Originally posted by @jorgeorpinel in #43 (comment)

[jorgeorpinel]

Cc @rogermparent @julieg18 👋🏼

[jorgeorpinel]

Also usage. Maybe that one should be part of the docs engine repo itself?

[rogermparent]

We have usage, dvc, and dvctable in the theme repo already. It's likely we'll include highlighters for all our tools considering cross-tool usage is an important feature of all of them.

[jorgeorpinel]

we'll include highlighters for all our tools considering cross-tool usage

Makes sense. We could even combine dvc and mlem since all that changes are the actual (sub)commands. Would be good to keep both names available (for the same highlighter) though, so you can include mlem commands in dvc blocks and vice versa.

But will this be sustainable? Consider a growing number of tools e.g. cml (rel. iterative/cml.dev#239), gto, ldb, etc.

I suspect the main integration is from everything to DVC so another option is to have dvc in the doc engine repo and somehow extend it in each product repo to add their commands.

[shcheklein]

I also think that we need one CLI highlighter ... I wonder if should even use something generic like cli

[yathomasi]

I also think that we need one CLI highlighter ... I wonder if should even use something generic like cli

I was also thinking, if we could use a generic highlighter like cli for all of the tools that highlights dvc, cml or mlem. Of course, we already have git and bash command so this generic option will make it easier, and consistent to use.

[yathomasi]

Proposal PR

• Supporting mlem commands
• Generic language cli for highlighting dvc, cml, mlem
• dvc still works(only dvc) and can be thought of as alias to cli
  • keeping it so it wouldn't break dvc.org

What do we think of a color for highlighting? Currently, we are using the same color for all the tools.

[shcheklein]

@yathomasi looks good to me! Same color is also fine to my mind.

[jorgeorpinel]

I can't see the gatsby-theme-iterative repo but sounds good.

[casperdcl]

About the Proposal PR - what about git? To me it's part of the dvc/cml/mlem group.

[yathomasi]

About the Proposal PR - what about git? To me it's part of the dvc/cml/mlem group.

git, bash commands will also be covered with generic cli language. So, I think it's going to be easier for us to maintain and use.

[jorgeorpinel]

Question 1: this is already implemented in this repo right? I see correct highlighting in blocks all over https://mlem.ai/doc.

Question 2: What about Windows (cmd)? That also qualifies as "CLI". At least in DVC.org we try to are a little about Windows users (example).

[yathomasi]

Question 1: this is already implemented in this repo right? I see correct highlighting in blocks all over https://mlem.ai/doc.

Yes, it's already available to the repo #45.

Question 2: What about Windows (cmd)? That also qualifies as "CLI". At least in DVC.org we try to are a little about Windows users (example).

It's working with dvc highlighter, so cli also should be covering them as well.

[yathomasi]

With the #81 merged, syntax highlighting for tools should be available through generic cli.

[casperdcl]

@yathomasi can we have this ported to cml.dev too? 🙏

[yathomasi]

@yathomasi can we have this ported to cml.dev too? 🙏

@casperdcl It's already available.

• example Live => cml.dev/doc/ref/ci
• Also, opened a issue for content update Update docs content to use Prismjs syntax highlighting and ref: auto-link options cml.dev#239