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

[Feature] Code Fences #12

Closed
zicklag opened this issue Dec 6, 2019 · 4 comments
Closed

[Feature] Code Fences #12

zicklag opened this issue Dec 6, 2019 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@zicklag
Copy link

zicklag commented Dec 6, 2019

Would it be possible to support code fences? The README says that they are not supported and I was not sure if that was a intentional design decision.

The purpose for supporting code fences, in my case, is that I am taking the same markdown that I am using for Termimad and using it to power my online documentation with mdbook. mdbook supports syntax highlighting when using code fences, so if Termimad allowed them, even without syntax highlighting, it will allow me to use syntax highlighting in mdbook.


On a side note, only because of Termimad am I able to use the same documentation for the CLI and the web documentation and it is awesome. Thanks a lot for helping enable this for my project:

image

@Canop Canop added the enhancement New feature or request label Dec 6, 2019
@Canop Canop self-assigned this Dec 6, 2019
@Canop
Copy link
Owner

Canop commented Dec 7, 2019

Let's clarify: yes it was intentional.
I don't like code fences.
They break the design of Markdown, which was initially line oriented, meaning that looking at any part of a pure markdown text you could know what you were looking at (ie: some code, some simple text, some list item, some table row, etc.). Introducing code fences changes it to a markup format where you need the whole previous text to know whether you're looking at some code or not.

Now... this being stated... introducing code fences would be easy and I'll probably do it, as a pragmatic utility.

@zicklag
Copy link
Author

zicklag commented Dec 7, 2019

Yeah, I can see where the concern is. Thanks for trying it. :)

@Canop Canop closed this as completed in c02f1b1 Dec 20, 2019
@zicklag
Copy link
Author

zicklag commented Dec 20, 2019

Looks like it isn't working with templates? Here is a gist which has a modified version of the scrollable example using a template. Am I doing something wrong?

It is interpreting the triple backtick as a horizontal rule and then interpreting the rest of the code inside as markdown.

@Canop
Copy link
Owner

Canop commented Dec 21, 2019

@zicklag I've opened a new issue for that: #14

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

No branches or pull requests

2 participants