-
-
Notifications
You must be signed in to change notification settings - Fork 8.9k
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
feat(v2): bootstrap bootstrap (heh) theme, preset, template #2557
Conversation
Deploy preview for docusaurus-2 ready! Built with commit 13302da |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Let's make the changes and we can merge this
packages/docusaurus-init/templates/bootstrap/website/docusaurus.config.js
Outdated
Show resolved
Hide resolved
We should split this PR up into smaller ones. I think your original PR containing the theme was the right size, you didn't have to add the template and the preset. We could always do it incrementally:
It's ok, we'll merge this since most of the stuff is content which already exists |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll make the changes and let you review one final time before we merge this.
EDIT: To prevent conflicts, I'll merge this first. Here's a summary of the changes I made:
- Renamed package names to
@docusaurus/
scope to leverage on monorepo capabilities - Removed blog plugin for now as we haven't implemented the theme components.
- Added the page plugin instead so that we can start the bootstrap template and see something
- Removed the (currently) unused stuff from the template (docs and blog markup)
Bootstrap template now which only has the index page. Note that the src/pages/index.js
also needs to be updated with Bootstrap classes, but that can be done later.
dbef6da
to
13302da
Compare
Shouldn't we encourage people to use our own CSS framework of Infima? Also, if the Bootstrap theme is the core package, it means we have to support +1 theme, right? I do not quite understand the meaning of this 🤷♂️. |
Yes but we also don't want people to be locked into our CSS framework if they don't feel like it and give them the option to choose their own CSS framework. I believe this is better for the community in the longer term.
For now it'll be maintained by us but in future it could be moved out and maintained by the community if we find that we don't have the bandwidth to support it. It's also a good chance and test for us to evaluate how clean our architecture is. If we can easily implement a new theme without changing anything in |
I agree that can be problematic, if we need to give support for many themes. But as yangshun said, I see a good way to evaluate and think in ways that can allows us to be more extensible and flexible. Is common that the users need other visual identities, if we don't provide ours, they'll create their own, is more to have standardised components, but in a near future, we can provide a showcase of themes builted by community. |
Motivation
I would like to start a new theme based on bootstrap components. This PR adds the initial structure.
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
N\A
I was thinking if is not cool add the prefix EXPERIMENTAL on the folder 🤔
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)