Skip to content

towards v1.0.0 #4

@obedm503

Description

@obedm503

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions