Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for line numbers in Markdown code fences #1381

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion packages/kg-markdown-html-renderer/lib/markdown-html-renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,35 @@ const namedHeaders = function ({ghostVersion} = {}) {
};
};

const fenceLineNumbers = function (md) {
const proxy = (tokens, idx, options, env, self) => self.renderToken(tokens, idx, options);
const defaultFence = md.renderer.rules.fence || proxy;

// Originally from https://github.com/coreyasmith/markdown-it-fence-line-numbers
md.renderer.rules.fence = function (tokens, idx, options, env, self) {
const token = tokens[idx];
const info = token.info;
const attribute = 'line-numbers';

if (!info) {
return defaultFence(tokens, idx, options, env, self);
}

// line-numbers must come after the first word in the info string to be rendered.
// Example: ```ruby line-numbers
// If line-numbers is specified as the first word, fallback to the default behavior
// (i.e., treat line-numbers as the language).
const langAttrs = info.split(/(\s+)/g).slice(2).join('');
const attributeRegex = new RegExp(`\\b${attribute}\\b`);
if (!langAttrs || !attributeRegex.test(langAttrs)) {
return defaultFence(tokens, idx, options, env, self);
}

token.attrJoin('class', attribute);
return defaultFence(tokens, idx, options, env, self);
};
};

const selectRenderer = function (options) {
const version = semver.coerce(options.ghostVersion || '4.0');

Expand Down Expand Up @@ -77,7 +106,8 @@ const selectRenderer = function (options) {
.use(require('markdown-it-image-lazy-loading'))
.use(namedHeaders(options))
.use(require('markdown-it-sub'))
.use(require('markdown-it-sup'));
.use(require('markdown-it-sup'))
.use(fenceLineNumbers);

markdownIt.linkify.set({
fuzzyLink: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,27 @@ describe('Markdown HTML renderer', function () {
const result = renderer.render(markdown, {ghostVersion: '3.0'});
result.should.containEql('loading="lazy"');
});

it('outputs `line-numbers` class on fenced code blocks when specified', function () {
const markdown = `
\`\`\`javascript line-numbers
const foo = 'bar';
\`\`\`
`;
const result = renderer.render(markdown, {ghostVersion: '4.0'});
result.should.containEql('class="line-numbers language-javascript"');
});

it('does not output `line-numbers` class on fenced code blocks when not specified', function () {
const markdown = `
\`\`\`javascript
const foo = 'bar';
\`\`\`
`;
const result = renderer.render(markdown, {ghostVersion: '4.0'});
result.should.containEql('class="language-javascript"');
result.should.not.containEql('line-numbers');
});
});

describe('<4.x', function () {
Expand All @@ -43,5 +64,16 @@ describe('Markdown HTML renderer', function () {
result.should.match(/<h1 id="headerone">/);
result.should.match(/<h2 id="hadertwo">/);
});

it('does not output `line-numbers` class on fenced code blocks when specified', function () {
const markdown = `
\`\`\`javascript line-numbers
const foo = 'bar';
\`\`\`
`;
const result = renderer.render(markdown, {ghostVersion: '3.0'});
result.should.containEql('class="language-javascript"');
result.should.not.containEql('line-numbers');
});
});
});
Loading