Fortran-FOSS-Programmers / Fortran-FOSS-Programmers/ford

Markdown line breaks not working in lists

Open
#646 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
458
Forks
138
PR merge metrics
No merged PRs in 30d

Description

I have a list in my documentation page, and I want to insert a line break in some of the list items.
Usually in markdown I would use a trailing `\` (works in GitHub, GitLab and more generally elsewhere).

However, when the html is created with FORD there is no line break and instead the '\' appears as part of the rendered text.
As a workaround I have to resort to using a `
` instead which is less 'markdownthonic'.

If the `
` didn't work either I'd guess the inputs were getting sanitised somewhere to cause this, but I'm not sure why it happens.
It'd be a 'nice to have' functionality.

My specific example with `
` where I'd prefer to use `\`:

```markdown
* Reducing the overheads for coupling PyTorch machine learning models to Fortran

ML & DL Seminars, LSCE, IPSL, Paris - November 2023

[Slides](https://jackatkinson.net/slides/IPSL_FTorch/IPSL_FTorch.html) - [Recording](https://www.youtube.com/watch?v=-NJGuV6Rz6U)
* Reducing the Overhead of Coupled Machine Learning Models between Python and Fortran

RSECon23, Swansea - September 2023

[Slides](https://jackatkinson.net/slides/RSECon23/RSECon23.html) - [Recording](https://www.youtube.com/watch?v=Ei6H_BoQ7g4&list=PL27mQJy8eDHmibt_aL3M68x-4gnXpxvZP&index=33)
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.