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

feat: Add image captions support #586

Open
wants to merge 3 commits into
base: master
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
2 changes: 1 addition & 1 deletion src/transform/plugins/images/collect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const collect = (input: string, options: Options) => {
if (singlePage && !path.includes('_includes/')) {
const newSrc = relative(root, resolveRelativePath(path, src));

result = result.replace(src, newSrc);
result = result.replace(new RegExp(src, 'g'), newSrc);
}

copyFile(targetPath, targetDestPath);
Expand Down
61 changes: 59 additions & 2 deletions src/transform/plugins/images/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,62 @@ function convertSvg(
}
}

function imageCaption(state: StateCore) {
const tokens = state.tokens;

for (let i = 0; i < tokens.length; i++) {
if (tokens[i].type !== 'inline') {
continue;
}

const childrenTokens = tokens[i].children || [];
const newTokens: Token[] = [];

for (let j = 0; j < childrenTokens.length; j++) {
const token = childrenTokens[j];

if (token.type === 'image') {
const attrs = token.attrs || [];
const hasCaptionAttr = attrs.some(([key]) => key === 'caption');

if (hasCaptionAttr) {
const captionAttr = attrs.find(([key]) => key === 'caption');
const explicitCaption = captionAttr ? captionAttr[1] : '';
const title = attrs.find(([key]) => key === 'title');
const captionText = explicitCaption || (title ? title[1] : '');

const figureOpen = new state.Token('figure_open', 'figure', 1);
const figureClose = new state.Token('figure_close', 'figure', -1);

if (captionText) {
const captionOpen = new state.Token('figcaption_open', 'figcaption', 1);
const captionContent = new state.Token('text', '', 0);
captionContent.content = captionText;
const captionClose = new state.Token('figcaption_close', 'figcaption', -1);

newTokens.push(
figureOpen,
token,
captionOpen,
captionContent,
captionClose,
figureClose,
);
} else {
newTokens.push(figureOpen, token, figureClose);
}
} else {
newTokens.push(token);
}
} else {
newTokens.push(token);
}
}

tokens[i].children = newTokens;
}
}

type Opts = SVGOpts & ImageOpts;

const index: MarkdownItPluginCb<Opts> = (md, opts) => {
Expand All @@ -110,7 +166,8 @@ const index: MarkdownItPluginCb<Opts> = (md, opts) => {
const didPatch = childrenTokens[j].attrGet('yfm_patched') || false;

if (didPatch) {
return;
j++;
continue;
}

const imgSrc = childrenTokens[j].attrGet('src') || '';
Expand All @@ -124,7 +181,6 @@ const index: MarkdownItPluginCb<Opts> = (md, opts) => {

childrenTokens[j].attrSet('yfm_patched', '1');
}

j++;
}

Expand All @@ -138,6 +194,7 @@ const index: MarkdownItPluginCb<Opts> = (md, opts) => {
md.core.ruler.push('images', plugin);
}

md.core.ruler.push('image_caption', imageCaption);
md.renderer.rules.image_svg = (tokens, index) => {
const token = tokens[index];

Expand Down