Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs content to use Prismjs syntax highlighting and ref: auto-link options #239

Closed
yathomasi opened this issue May 16, 2022 · 9 comments
Labels
documentation Markdown files enhancement New feature or request

Comments

@yathomasi
Copy link
Contributor

yathomasi commented May 16, 2022

With #233, the following features were added

  1. prismjs syntax highllighting #157
  2. ref: auto-link options #187

Now, we need to update content similar to dvc.org to use them (jump to #239 (comment)).

cc: @iterative/docs

@yathomasi yathomasi added documentation Markdown files enhancement New feature or request labels May 16, 2022
@jorgeorpinel
Copy link
Contributor

the following features were added

Can you be specific about which highlighters exist or how to enable them, as well as auto-linking? We'll want to document this at some point anyway (maybe in the docs engine repo README + contrib guides).

@yathomasi
Copy link
Contributor Author

Existing highlighters:

  1. dvc
    • parses on line basis (accepts $ as first character which is skipped while copying)
    • highlights
      • dvc commands
      • git commands
      • bash commands
  2. dvctable
    • parses on row/line basis
    • highlights
      • white|neutral
      • yellow|metric
      • blue|param
      • violet|dep
  3. usage
    • highlights
      • dvc commands
      • cml commands (addition)
      • usage commands usage|positional arguments|optional arguments
      • args highlights the arguments in [--arg] pattern (inside square bracket with double dashes) (auto-linking)
  4. cml (addition)
    • parses on line basis (accepts $ as first character which is skipped while copying)
    • highlights
      • cml commands
      • git commands
      • bash commands

Usage:

```dvc | dvctable| usage| cml
respective content
```

@casperdcl
Copy link
Contributor

casperdcl commented May 18, 2022

Er... Can

  • cml be an alias of dvc?
  • both of the above highlight all of our tools (dvc/cml/mlem/...)?

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented May 18, 2022

Can cml be an alias of dvc? ... highlight all of our tools

See discussion in iterative/mlem.ai#59 (comment) 🙂

@casperdcl
Copy link
Contributor

Yes basically would like this rather than this

@jorgeorpinel
Copy link
Contributor

Is this still outstanding @yathomasi ? Thanks

@jorgeorpinel jorgeorpinel added A: website Area: website website: eng-doc DEPRECATED JS engine for /doc and removed documentation Markdown files A: website Area: website labels Aug 24, 2022
@rogermparent
Copy link
Contributor

Seems like the cli highlighter that's already in closes this issue.

@jorgeorpinel
Copy link
Contributor

Can cml be an alias of dvc?

Note that the highlighter name is now cli @casperdcl . I think both dvc and cml will be aliases of that but I recommend we use cli going fwd.

Do you want to keep this issue open to update existing content and use the highlighters more?

@jorgeorpinel jorgeorpinel added documentation Markdown files and removed website: eng-doc DEPRECATED JS engine for /doc labels Aug 25, 2022
@rogermparent
Copy link
Contributor

Unless something has changed, we only have dvc as an alias but we're encouraging moving to full cli, we've already mass replaced instances of ```dvc in a few repos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants