saberland/saber

A plugin that uses shiki to highlight code blocks

Open

#462 ouverte le 18 sept. 2019

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)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.

Guide contributeur

Stack technique
javascriptvuenodejs
Domaine
frontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Node.jsSaber static site generatornpmVue.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
55
Direction de recherche
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.