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 (2,151 stars) (127 forks)batch import
good first issuehacktoberfestplugin

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

Tech stack
javascriptvuenodejs
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Node.jsSaber static site generatornpmVue.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
The issue requests a Saber plugin to use Shiki for syntax highlighting. Start by examining the existing 'saber plugin prismjs' as a reference for structure and API. Then, review the Shiki package documentation to understand how to integrate its highlighting capabilities. The plugin should be configurable via saber config.yml. No linked PRs or comments provide further direction, so the implementation details are left to the contributor.