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

towards v1.0.0 #4

Open
3 tasks done
obedm503 opened this issue Sep 16, 2017 · 4 comments
Open
3 tasks done

towards v1.0.0 #4

obedm503 opened this issue Sep 16, 2017 · 4 comments

Comments

@obedm503
Copy link
Owner

obedm503 commented Sep 16, 2017

with the intention of moving towards a 1.0.0 stable release I'm opening this issue for anyone to voice their opinions on the behavior and api of the extension.

changes

some of the things I would like to change include:

  • renaming to showdown-katex: since this is a showdown extension that serves as a bridge to katex, I believe the name change makes it easier to understand what this project is
  • renaming would also mean that configuration would now be set using showdownKatex.config passed to the extension factory function instead of katex.config. I also don't what to use the katex namespace.
  • since there is now a way to render things inline (meaning without triple backticks) it might make sense to deprecate them. There's also the option to make the backticks work as a shortcut to displayMode: true

some questions

  • good inline asciimath delimiters? the syntax I have until now is using single ~ surrounding the asciimath (~ y = mx + b ~). why not single backtick like MathJax? because this is markdown. backticks already mean something in markdown. In fact the single tilde seems just as readable as the single backtick for inline math
  • is it necessary to have default asciimath in displayMode delimiters? if triple backtick becomes forced displayMode this will not be needed

any input is welcome

@benoit-sbr

@benoit-sbr
Copy link

Hi again obedm503!

To me the inline rendering support is a big enhancement.

My typical usecase will involve markdown formatted files with the classic $ delimiters used in LaTeX. Do you think these would make good delimiters?

@benoit-sbr
Copy link

Hi obedm503!

What do you think of the above?

@obedm503

@obedm503
Copy link
Owner Author

obedm503 commented Jan 6, 2018

@benoit-sbr what do you think of the new delimiters

delimiters: ([

@arguiot
Copy link

arguiot commented Jan 22, 2020

Hi, you should also bump katex version to the lastest

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

No branches or pull requests

3 participants