imagej / imagej/imagej.github.io

Syntax highlighting preview isn't available for local builds

Open
#166 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
30
Forks
203
Avg merge
1h 50m
Merged PRs (30d)
1

Description

When using code fences (\`\`\` \`\`\`) we do not see code syntax highlighting when building locally. This has something to do with using jekyll 4.2 directly instead of the gh-pages gem. It would be nice to have this preview.

In the interim, adding a note to [code editing](https://github.com/imagej/imagej.github.io/blob/main/_pages/editing/code.md).

Contributor guide

No contributing guide indexed for this repository

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

Start by running the local Jekyll build and inspecting how it handles fenced code compared with the gh-pages gem. Read _pages/editing/code.md for the interim documentation path. Done means local builds show syntax highlighting, or the page clearly documents the limitation and workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll, markdown
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.