-
Notifications
You must be signed in to change notification settings - Fork 17
Migrate docs site to Docsify #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@galargh result looks good, I'll review it today; two questions
|
Totally! It was worth spending time thinking about 0.5.3 though because multi-version support in docs is not that obvious. Note to self: look if we can simplify multi-version/language support using https://github.com/palkan/docsify-namespaced (https://evilmartians.com/chronicles/easy-multi-language-multi-version-documentation-with-docsify-git-and-github-actions). At a first glance it looks nicer than what we currently have on this branch. EDIT I decided not to pursue this now.
Sounds great too! I'll move this version of repo to |
@laurentsenta I thought of a pretty good reason why we might want to hold off on moving the docs to |
@laurentsenta My suggestion would be to:
|
This PR enables migration from GitBook to Docsify. I used Docsify because it allowed me to use the exact same format/structure as GitBook. This made the migration process really quick.
It introduces a new landing page that is required by Docsify.
It sets up automated deployments of both
master
andv0.5.3
branches to GitHub Pages.It removes Gitbook specific constructs from
.md
files.Before this PR can be merged, we should:
pages.yml
so that it doesn't point at this branchv0.5.3
branch to docsifyI'm leaving the above open until we agree with @laurentsenta this is the approach we want to take.
The current version of the docs site powered by Docsify can be viewed at: https://testground.github.io/docs/