search

hedgedoc / react-client

The frontend of the upcoming version 2.0
https://hedgedoc.dev
GNU Affero General Public License v3.0
104 stars 13 forks source link

Upgrade To Bootstrap 5 #1696

Closed LabinatorSolutions closed 1 year ago

LabinatorSolutions commented 2 years ago

Which part of the project should be enhanced?

Upgrade To Bootstrap 5.1.3+

Is your enhancement request related to a problem? Please describe.

No response

Describe the solution you'd like

The generated HTML file is still using an outdated version of Bootstrap (3.4.1). Upgrading to Bootstrap 5.1.3+ might be a good call unless there are some compatibility issues in doing so.

Describe alternatives you've considered

Alternatively, in an ideal scenario, you might also consider upgrading to an accessible CSS framework instead of Bootstrap. One of the best would be the USWDS (https://designsystem.digital.gov/).

Additional context

No response

mrdrogdrog commented 2 years ago

Thanks for your issue.

As you can see in the README HedgeDoc 1 is in maintenance only mode. So an upgrading of bootstrap won't happen for HedgeDoc 1 because we're working on a complete rewrite (which contains also the frontend ). The new frontend is built with a newer bootstrap version. Right now it's BS4. We plan to upgrade to bs5 as soon as we figured out some design and layout issues.

LabinatorSolutions commented 2 years ago

Thanks for your issue.

As you can see in the README HedgeDoc 1 is in maintenance only mode. So an upgrading of bootstrap won't happen for HedgeDoc 1 because we're working on a complete rewrite (which contains also the frontend ). The new frontend is built with a newer bootstrap version. Right now it's BS4. We plan to upgrade to bs5 as soon as we figured out some design and layout issues.

Thank you for pointing that out.

Since you are working on a new version, it would be worthwhile to check better accessible CSS frameworks other than Bootstrap. Here are the most notable ones:

The above two CSS frameworks have been approved by governments as they pass all accessibility checks. They are way superior to Bootstrap in terms of code quality and design.

Why Accessibility Matters?

Well, apart from the fact that it is required by law, it is also a big feature to brag about on your pages. There are absolutely zero accessible markdown-to-html generators. When you consider a feature like that, you will instantly stand up from the crowd. Implementing another CSS framework also takes as much time as implementing Bootstrap 5.

mrdrogdrog commented 2 years ago

One of our goals for HD2 is indeed to increase accessibility.

But we don't know if we can achieve this goal in 2.0 or in 2.x. First we have to figure out some more important technical issues. We planned to combine the upgrade of bs with a redesign/relayout attempt of the whole app which is quite hard because our last two designers suddenly have jumped off the project. So it could take some time. Maybe we even have to ship 2.0 with BS4 and implement the new UI later. 🤷

LabinatorSolutions commented 2 years ago

One of our goals for HD2 is indeed to increase accessibility.

But we don't know if we can achieve this goal in 2.0 or in 2.x. First we have to figure out some more important technical issues. We planned to combine the upgrade of bs with a redesign/relayout attempt of the whole app which is quite hard because our last two designers suddenly have jumped off the project. So it could take some time. Maybe we even have to ship 2.0 with BS4 and implement the new UI later. shrug

Thank you for your reply. I wish your team all the best!

All in all, I love your project! If I get any free time next year, I will contact you to see how to join onboard. At the moment, though, my schedule is totally full.

P.S: You can also consider creating a SaaS like HackMD. Something like a collaboration tool with a subscription model. Many open-source solutions offer cloud services and tools for companies to support their open source development.

DerMolly commented 1 year ago

done