Freecodecamp: Convert all video questions to markdown style?

Created on 2 Jun 2020  路  13Comments  路  Source: freeCodeCamp/freeCodeCamp

The questions in the video challenges are a mix of markdown and html. Some use markdown - and some use html style.

This issue is for a discussion on if we want to convert them all to use markdown and possibly remove all the references of html availability in the documentation.

There's certainly cases where formatting with markdown makes the question harder to read. If the question doesn't have any code or html tags, the only reason to use the markdown format (all the |'s) is to just make it consistent and maybe keep some confusion down when people come across the different versions.

help wanted learn

Most helpful comment

I vote to just make them all markdown. It gives us a standard that gives people a concrete way to make them. And hopefully stop anyone from having to decide, 'should this use markdown', or 'can I leave it html'. Everyone will have an answer to that, and hopefully be on the same page.

All 13 comments

Personally, I find writing and reading any challenges with code much simpler and easier with MarkDown. I am not bothered, if the challenges without code in the question/answer use HTML, but then we have the situation without consistency.

It's a good question. I think it would help to convert challenges like the one Tom linked to, as they are (at least to my eyes) needlessly hard to read.

As for the less obvious stuff, I've created a PR, https://github.com/freeCodeCamp/freeCodeCamp/pull/38992, that deals with one confusing issue - namely that you had to quote numbers for the challenge to be parsable. That leaves weird edge cases like

question:
  answers:
  - *5*

which throws

  unidentified alias "5*" at line 6, column 8:
      - *5*
           ^ in file ...

but that's unlikely to come up much.

Finally "word", 'word' and word all just parse to word, while doing the same with | gives you
image. How confusing is that to everyone?

I vote to just make them all markdown. It gives us a standard that gives people a concrete way to make them. And hopefully stop anyone from having to decide, 'should this use markdown', or 'can I leave it html'. Everyone will have an answer to that, and hopefully be on the same page.

People seem broadly in favour, so PRs are welcome. There's no need to change all the challenges in one go, but if anyone is planning to do a large batch please comment here (to avoid work duplication).

Can I start working on this?

@JapneetSingh5 please do! If you're worried about the 'first timers welcome' label, I added that to indicate that it should not be too hard, not that only first timers should submit PRs.

Awesome, I鈥檒l get to work then!

I am experiencing failed build tests.

is it still open. If it is open then may i work on this

@JapneetSingh5 is https://github.com/freeCodeCamp/freeCodeCamp/pull/39022 intended to convert all the challenges? If not, could you leave a note here?

@pulkitgovrani you're welcome to work on this, but it could save time to wait on @JapneetSingh5's response.

im working on 03-frontend roght now, we can divide folders i think

Great stuff. Might be worth chatting on Gitter/discord to co-ordinate. As you wish.

I'm really sorry for the delay on this, I will open a pull request next week for sure.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

QuincyLarson picture QuincyLarson  路  114Comments

doubleUTF picture doubleUTF  路  45Comments

ryanarnouk picture ryanarnouk  路  39Comments

thecodingaviator picture thecodingaviator  路  42Comments

dlwebdev picture dlwebdev  路  47Comments