Broken link report

[srid]

Add a special page (live server only) that lists all broken links in the notebook.

• run: Live server report
• gen: static site report & failure Relative link & anchors support; broken link detection #268

[srid]

Also if there are broken links, static site generation should fail.

[vcavallo]

This log is a little confusing:

       > [Error#emanote] Found 225 broken links! Emanote generated the site, but the generated site has broken links.
       > [Info#emanote] (Tip: use `--allow-broken-links` to ignore this check.)

for a few reasons:

• The static site generated actually fails ("Emanote generated the site"...)
• What is the --allow-broken-links flag and how does one use it?

[srid]

Welcome back @vcavallo

• The static site generated actually fails ("Emanote generated the site"...)

What do you mean by 'fail'?

• What is the --allow-broken-links flag and how does one use it?

It will convert this error to a warning, allowing emanote to exit with zero exit code.

emanote --allow-broken-links gen /tmp/output

[vcavallo]

Hello again, @srid

What do you mean by 'fail'?

I meant an exit code of 1 and no generated site.

emanote --allow-broken-links gen /tmp/output

Yup! that did the trick. I was trying to pass that flag to nix build and not having a good time of it :)

It would be helpful to have that flag option listed in the emanote help.

Thanks!

[vcavallo]

While I'm here: How would one adjust the .github/workflows/publish.yml step where nix build -j 4 is called in order to allow broken links?