Github, Gitlab, Bitbucket, Azure DevOps, and likely others, all support some form of git-repo-backed Wiki. Rather than forcing users of those platforms to convert those wikis to Orchid's format, why not provide adapters to build Orchid's wikis based on their formats?
By default, Orchid will use the current format for building wikis, of parsing a summary.md file and building the tree of its links. Instead, you should be able to set up each section's adapter to one of the available adapters. Each adapter is free to load its Wiki content in whatever way it needs to.
For the git-based wikis, this will involve cloning the project at runtime, and then the adapter will determine how to build the hierarchy from its content.
This should go hand-in-hand with #254 , as these wiki adapters should be created as part of those integration projects.
To-do
[x] Modularize wiki creation so that the current method is just the orchid adapter. Also, add a base class for a git-based adapter, so the other adapters only need to worry about file structure
Github, Gitlab, Bitbucket, Azure DevOps, and likely others, all support some form of git-repo-backed Wiki. Rather than forcing users of those platforms to convert those wikis to Orchid's format, why not provide adapters to build Orchid's wikis based on their formats?
By default, Orchid will use the current format for building wikis, of parsing a
summary.mdfile and building the tree of its links. Instead, you should be able to set up each section's adapter to one of the available adapters. Each adapter is free to load its Wiki content in whatever way it needs to.For the git-based wikis, this will involve cloning the project at runtime, and then the adapter will determine how to build the hierarchy from its content.
This should go hand-in-hand with #254 , as these wiki adapters should be created as part of those integration projects.
To-do
orchidadapter. Also, add a base class for a git-based adapter, so the other adapters only need to worry about file structuregithubadapter for GitHub Wikisgitlabadapter for GitLab Wikisbitbucketadapter for Bitbucket Wikisazureadapter for Azure DevOps Wikis