GH_EDIT_LINK setting does not work - Githubissues

dendronhq / dendron

The personal knowledge management (PKM) tool that grows as you do!

https://wiki.dendron.so

Apache License 2.0

6.75k stars 257 forks source link

GH_EDIT_LINK setting does not work #1612

Open SR-- opened 3 years ago

SR-- commented 3 years ago

Please select the area your bug applies to. (Multiple selections are Possible)

[ ] Onboard. Initial vault setup and import/export pods
[ ] Create. Note creation, lookup, snippets and templates
[ ] Retrieve. Backlinks, references, graph view
[ ] Structure. Refactoring, multi-vault and schemas
[x] Publish. Sharing your repo with the world
[ ] Misc (Choose this if your not sure)

Describe the bug

GH_EDIT_LINK set to true has no effect

To Reproduce

Set the GH_EDIT_LINK flag to true in dendron.yml
Publish using nextjs and cli commands.
No link is visible.

Expected behavior

The link should appear as per the docs

Screenshots

jonathanyeung commented 3 years ago

Hi @SR-- - two things to check:

Can you explicitly specify the gh_edit_repository property?
```
gh_edit_repository: 'https://github.com/dendronhq/dendron-site'
```
This needs to be specified if the vault isn't setup to be remote.
Double check that your gh_edit_branch exists. Is it named 'master' and not 'main'?

If these work, let me know and I'll have our docs updated.

SR-- commented 3 years ago

For the record. This does work if the repository is public, the gh_edit_repository is set explicitly, gh_edit_link is set to true

The expected default for gh_edit_link does not work The behavior is broken if the repo is private

Thanks @jonathanyeung