rust-lang / rust-lang/mdBook

Support syntax-highlighting Dockerfiles

Open
#2,445 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

Currently, the version of highlight.js shipped with mdBook does not support syntax highlighting Dockerfiles.

Proposed Solution

Add dockerfile to the list of default highlight.js languages

Notes

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate mdBook's default highlight.js language list and inspect how its entries are registered. Add Dockerfile support there, then verify that a fenced Dockerfile code block is highlighted correctly; the issue does not name a specific file or test.

Written by the indexing model from the issue text.

Assessment

Tech stack
dockerfile, rust
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.