Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[v2] Proposal: set custom_edit_url to 'null' to disable `Edit this Page` button

See original GitHub issue

Proposing this feature after approval for filing by @yangshun.

Proposal

Add a frontmatter boolean to allow per-page disabling of the Edit this Page button. E.g.

no_edit_button: true

Default value would be false

Why?

It’s not always possible to generate a correct custom_edit_url like in this real-life example from the Pester website

additional markdown is generated from a remote source
for these pages the global editUrl setting cannot be used
not all of these remote sources can be edited/resolved
it is therefore impossible to create a page-specific custom_edit_url
leading to 404 errors when pressing the Edit this Page button for these type of pages

The current IRL workaround is to disable all edit buttons, very suboptimal

How would this solve it?

Users would be able to disable the Edit this Page button on a per-page basis.

This should also cover all future use-cases.

Issue Analytics

State:
Created 4 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

2reactions

endilieycommented, Dec 30, 2019

PR welcome.

0reactions

bravo-kernelcommented, Dec 30, 2019

Thanks for thinking about this. I would personally prefer to NOT use swizzling for this and make this (the null suggestion) a core feature. This way we can benefit of future releases without any changes.

I will ask for a PR, thanks ❤️