GitbookIO / integrations

Toolkit to build integrations on GitBook
74 stars 42 forks source link

Sync with gitlab/github project's wiki repository #447

Closed cesarizu-incine closed 5 months ago

cesarizu-incine commented 5 months ago

There seems to be no way to sync with a gitlab/github project's wiki. The repository for the wiki is not the same as the main repository. The url is the same but with .wiki.git instead of .git. This applies to both github and gitlab.

See:

Is there a way to sync with the wiki repository of a project instead of the main repository?

addisonschultz commented 5 months ago

Hi @cesarizu-incine - good question. Do you have an example of a public wiki I could look into? We offer the option to sync with monorepos: https://docs.gitbook.com/integrations/git-sync/monorepos

I'm wondering if setting the monorepo directory to the wiki path would work?

cesarizu-incine commented 5 months ago

There are a lot of examples for GitHub here (GitLab works the exact same way): https://github.com/MyHoneyBadger/awesome-github-wiki?tab=readme-ov-file#examples

Just one example from that list:

It is a different repository, so using the monorepo directory wouldn't work.

addisonschultz commented 5 months ago

Hi @cesarizu-incine - I see now, it's a good feature request. I've moved it to our community, where this feature request would fit better! Feel free to leave more context there for us to check out.

https://github.com/orgs/GitbookIO/discussions/583

Thanks again for filing, I'm going to close this feature request in this repository for now.

addisonschultz commented 5 months ago

Hey @cesarizu-incine - just wanted to update: You can actually import a GitHub Wiki into GitBook!

https://docs.gitbook.com/content-editor/import

Hope that helps!