-
Notifications
You must be signed in to change notification settings - Fork 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
Use Docsy Theme #338
Use Docsy Theme #338
Conversation
horizontal padding is handled by Bootstraps grid
The preview environment for this PR is here: https://deploy-preview-338--rapids-ai.netlify.app/. The preview site should look mostly indistinguishable from our production site, https://rapids.ai/. Here is how the documentation pages look in a preview environment so far (ugly, indeed): https://deploy-preview-338--rapids-ai.netlify.app/docs/. Here's how a default Docsy doc page looks for reference: https://www.docsy.dev/docs/. Potential Follow-up tasks:
|
Allan and I reviewed this collectively yesterday and he gave a verbal approval to merge. therefore I will admin merge this PR. |
Closes #334.
This PR updates our website to use the Docsy theme for Hugo.
Our site was previously using Bulma as its CSS framework, but Docsy uses Bootstrap.
To avoid having two CSS frameworks included in our site, I've migrated our HTML and CSS from Bulma to Bootstrap.
As a result, this PR touches pretty much all of the files in the repository.
Fortunately, Bootstrap is very configurable and a lot of its class names overlap with Bulma's. Therefore, I was able to configure Bootstrap with Bulma's font sizes, grid settings, etc. to make the transition a little bit easier.
There were a lot of CSS class names that needed to be changed.
The HTML changes consisted mostly of just adding an extra adding a
row
class to oursection
elements and wrapping thesection
contents in a<div class="col"></div>
.The exception here is the navigation bar, which had to be completely rewritten for Bootstrap.
Finally, I've added some draft content to the
docs/
directory and configured our Netlify preview environment to build drafts so they can be easily showcased.There is still more work to do for the documentation page styles, but this PR is a great starting point. I will add my thoughts on follow up tasks as a comment.