Skip to content
This repository has been archived by the owner on Nov 12, 2019. It is now read-only.

Add documentation on formula escaping #65

Open
gor181 opened this issue Jan 15, 2018 · 6 comments
Open

Add documentation on formula escaping #65

gor181 opened this issue Jan 15, 2018 · 6 comments

Comments

@gor181
Copy link
Contributor

gor181 commented Jan 15, 2018

@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
Copy link
Contributor

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

@ncarchedi
Copy link
Contributor

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

@gor181
Copy link
Contributor Author

gor181 commented Jul 4, 2018

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
Copy link
Contributor

@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
Copy link
Contributor

@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
Copy link
Contributor

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants