saberland/saber

A plugin that uses shiki to highlight code blocks

Open

#462 opened on Sep 18, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (127 forks)batch import
good first issuehacktoberfestplugin

Repository metrics

Stars
 (2,151 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Feature request

What problem does this feature solve?

https://shiki.matsu.io/

It uses TextMate grammar to tokenize strings, and colors the tokens with VS Code themes. In short, Shiki generates HTML that looks exactly like your code in VS Code, and it works great in your static website generator.

What does the proposed API look like?

# saber-config.yml
plugins:
  - saber-plugin-shiki

How should this be implemented in your opinion?

Check out saber-plugin-prismjs for reference.

Contributor guide

Research direction
Examine the reference plugin saber plugin prismjs to understand the plugin structure, then implement a similar plugin using Shiki for code highlighting. Integrate it into the Saber configuration.
Tech stack
javascriptvuenodejs
Domain
frontenddeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.jsSaber plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60