search

terror / mcgill.courses

A course search and review platform for McGill University
https://mcgill.courses
Creative Commons Zero v1.0 Universal
32 stars 8 forks source link

Support markdown formatting for review content #375

Open terror opened 1 year ago

ronyboi commented 6 months ago

hey @terror and team,

I was pretty impressed by your work. I was wondering if you guys are open to other contributors? I am a McGill CS alum and am interested in picking up this ticket. Let me know what you guys think. Thanks!

ronyboi commented 6 months ago

https://github.com/remarkjs/react-markdown

terror commented 6 months ago

hey @terror and team,

I was pretty impressed by your work. I was wondering if you guys are open to other contributors? I am a McGill CS alum and am interested in picking up this ticket. Let me know what you guys think. Thanks!

Hey Rohan! We're definitely open to contributors and would be happy if we got someone on this one. There is a minor thing we have to do to make it easier to contribute to with regard to dev environment variable exposure, once thats done we'll update the readme and it should be easy to get started.

ronyboi commented 6 months ago

Sure. Let me know once that's done! Happy to contribute :)

terror commented 6 months ago

Sure. Let me know once that's done! Happy to contribute :)

We updated the readme, for now we're gonna require contributors to join the discord server to get the credentials needed to work on the project!

https://discord.gg/Eh6eZ27C

ronyboi commented 6 months ago

Hi,

Do we want to support a markdown editor? We could consider adding https://uiwjs.github.io/react-md-editor/. That would be a bigger task.

39bytes commented 6 months ago

Do we even actually want this feature? I think this is a bad idea if unrestricted because things like markdown headers will kind of disrupt the page flow and be clunky. Maybe only supporting a subset of markdown (bold/italic, etc) would be better.

terror commented 6 months ago

Do we even actually want this feature? I think this is a bad idea if unrestricted because things like markdown headers will kind of disrupt the page flow and be clunky. Maybe only supporting a subset of markdown (bold/italic, etc) would be better.

+1 for the subset, didn't think how headers would interrupt the flow of the page

We could potentially look into something like quill (https://github.com/zenoamaro/react-quill) for this