Skip to content

support markdown for FAQ component #85

Description

@logonoff

Is your feature request related to a problem? Please describe.
As an FAQ author, I may want to add links for some of the answers in the FAQ page, or format some of the text, however there are currently no mechanisms for that to happen

Describe the solution you'd like
I would like the FAQ to become a markdown document, similar to CSSC's implementation (although I would much prefer headings instead of pipes to delimit questions and answers, e.g.,

## Category 1
### Question 1
Answer 1

### Question 2
Answer 2

## Category 2
### Question 1
Answer 1

)

Describe alternatives you've considered

  • the answer value in the JSON file to be pared differently such that answer can parse markdown syntax

I think a md document would be more readable in the long run however there are still questions on where to place the document, whether the FAQ deserves a separate page after this change, etc

Additional context
Add any other context or screenshots about the feature request here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions