ZINC-FYP-2022-23 / console

ZINC UI for teaching assistants
1 stars 0 forks source link

feat(gui): use markdown to store content #33

Closed AnsonH closed 1 year ago

AnsonH commented 1 year ago

Problem

Some parts of the GUI contain lots of text, such as the FAQ section in FileStructureValidation settings panel. A disadvantage of writing the content directly with JSX is that it's tedious to maintain as we need to manually add the appropriate HTML element tags.

Solution

A possible solution is that we write the content in Markdown files, then the Markdown is transformed into JSX during rendering. Here are some resources to look at:

:+1: Advantages:

:-1: Disadvantages:

AnsonH commented 1 year ago

Marking this as "won't do" because it introduces too much complexity.