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

Allow markdown text #103

Open
JocelynDelalande opened this issue Feb 28, 2020 · 3 comments
Open

Allow markdown text #103

JocelynDelalande opened this issue Feb 28, 2020 · 3 comments

Comments

@JocelynDelalande
Copy link

I am working on allowing markdown-formatted text in title, sub_title, text and name texts of sections.

My first approach was to use a setting to allow choosing between markdown and HTML rendering, defaulting to HTML for backward compat.

But, as markdown also allows plain HTML, I am wondering about just making it the only and default rendering option (simplifying documentation and use).

The major drawback I can think about would be for people who wrote HTML text with blank lines in it, that would get meaning and produce <p> in output. IMHO, that is an acceptable break (major version bump to indicate that ?).

Not a proof of anything, but I compiled my own galleries with my markdown patch without any difference in output.

So, two questions :

  • is that feature welcomed (PR ahead, already working locally) ?
  • what about making markdown rendering the default and only option ?
@beudbeud
Copy link
Collaborator

beudbeud commented Mar 4, 2020

All PRs are welcome :)

@JocelynDelalande
Copy link
Author

Thanks :).

So, @beudbeud to be a bit more precise (and avoid useless work) : making markdown the default and only option seems OK to you ?

@beudbeud
Copy link
Collaborator

beudbeud commented Mar 5, 2020

I'm okay for markdown if there aren't regression for people not use it.

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