nberlette/shikey

TODO: add support for MDC syntax (see @nuxt/content)

Open

#2 opened on Jun 7, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)TypeScript (0 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This requires an additional layer to the build step.

  1. check if mdc.tmLanguage.json exists; if yes then skip to step 5 step 4.
  2. pull the latest mdc.tmLanguage.json file from @nuxt/content
  3. write file into dist/assets/languages directory
  4. ensure the resource exists in the asset/import map (assets.ts)
  5. ...finish the remaining parts of build step

Note: See the MDC official TextMate language definition file: https://github.com/nuxt/content/blob/main/src/runtime/assets/mdc.tmLanguage.json

Contributor guide

Research direction
Implement the build steps as outlined: check for MDC language file, download if missing, add to assets map, and complete the remaining build logic.
Tech stack
typescriptnodejs
Domain
toolingbuild system
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
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65