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

Proposal: should missing local images links fail the build? #200

Open
kjantzer opened this issue Nov 6, 2018 · 1 comment
Open

Proposal: should missing local images links fail the build? #200

kjantzer opened this issue Nov 6, 2018 · 1 comment

Comments

@kjantzer
Copy link
Contributor

kjantzer commented Nov 6, 2018

Currently they do....

However, GitHub supports linking to repo images in the README markdown files, like so:

# <img src="./icons/32x32.png"> Bathroom Status Chrome Extension (example)

However, this currently fails the build because of line 64 in fix_html.js

throw new Error(${base}: Unknown reference '${origUrl}')

What do you think about changing the fatal error to a console.error so that the docs still build. I'd rather have a broken image then no docs at all.

Side note:
I looked around the Metalsmith docs to see if there was a way of copying the local image to the build directory, but I didn't find anything solution.

@knownasilya
Copy link
Member

knownasilya commented Nov 6, 2018

I'm totally for that change, as long as it is clearly communicated during the build what happened and what needs to happen to resolve it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants