Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A markdown list in report.md breaks compilation #3

Open
r03ert0 opened this issue Nov 12, 2020 · 3 comments
Open

A markdown list in report.md breaks compilation #3

r03ert0 opened this issue Nov 12, 2020 · 3 comments

Comments

@r03ert0
Copy link
Contributor

r03ert0 commented Nov 12, 2020

In the #Introduction section I had a paragraph with text. Compilation is broken if a list like this is added:

1. The changes of position and velocity as given by Newton's laws of motion.
2. The stresses as given by the elasticities and motions, also taking into account the
osmotic pressures as given from the chemical data.
3. The chemical reactions.
4. The diffusion of the chemical substances. The region in which this diffusion is possible is given from the mechanical data.

although that's valid markdown.

It should be maybe indicated which is the valid subset of markdown that works?

@r03ert0 r03ert0 changed the title A list in report.md breaks compilation A markdown list in report.md breaks compilation Nov 12, 2020
@agahkarakuzu
Copy link
Contributor

@r03ert0 lists should be added using latex convention, I think this is because of the pandoc version/latex template etc. we are using. Bringing in more markdown-native texting into the process is one of the open development issues.

@r03ert0
Copy link
Contributor Author

r03ert0 commented Nov 12, 2020

ok :)
For the moment, I think it's just good to let people know they shouldn't use some markdown syntax. Is there a document showing which is the subset of markdown that pandoc recognises? Currently, I'm adding text to a report.md file little by little to discover what works and what doesn't...

@agahkarakuzu
Copy link
Contributor

agahkarakuzu commented Nov 12, 2020

Thank you so much, we definitely need this to improve our documentation!

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

No branches or pull requests

2 participants