datacamp / authoring

https://authoring.datacamp.com/
Other
8 stars 9 forks source link

Add documentation on formula escaping #65

Open gor181 opened 6 years ago

gor181 commented 6 years ago

@vincentvankrunkelsven commented on Fri Jun 16 2017

LaTeX formulas in markdown should be escaped. E.g. in $x_{1}+x_{3}$, the _ must be escaped: $x\_{1}+x\_{3}$

ncarchedi commented 6 years ago

@gor181 is there a more general source for this information or is it specific to the way teach does things?

ncarchedi commented 6 years ago

@richierocks would you like this documented anywhere in particular in the authoring docs?

gor181 commented 6 years ago

Source is @vincentvankrunkelsven memory 😃. Another source would be checking the teach-parser source code.

From what I know escaping markdown is the only necessary thing to get them working properly.

richierocks commented 5 years ago

@ncarchedi Can adding equations by productized? In the meantime, a page in the 'Writing NormalExercises' directory would be most natural, I think.

https://github.com/datacamp/authoring/tree/master/docs/courses/exercises/normal-exercises

ncarchedi commented 5 years ago

@richierocks I don't think we want to create a whole UI just for building equations given the long list of other stuff we need to get to. But we could definitely create a small markdown formula cheat sheet and link to it somewhere in the editor or in a help article so it's easily findable. WDYT?

ncarchedi commented 5 years ago

I'd rather people don't have to leave the editor to find it.