BetterEm

Overview

BetterEm is an extension that aims to improve emphasis (bold and italic) handling.

BetterEm provides a smart which controls whether emphasis is processed mid-word or not. When smart_enable is enabled, mid-word emphasis is intelligently ignored. This can be applied to asterisk and underscore emphasis, but since it usually only desirable to avoid mid-word emphasis in with underscores, it is only enabled for underscores by default.

With the default behavior, the feel will be very similar to GFM bold and italic, within the bounds of what Python Markdown is capable of.

The BetterEm extension can be included in Python Markdown by using the following:

import markdown
md = markdown.Markdown(extensions=['pymdownx.betterem'])

Rules

BetterEm requires that non-whitespace characters follow the opening token(s) and precede the closing token(s).

This * won't emphasize *

This *will emphasize*

BetterEm allows for a more natural nested token feel.

***I'm italic and bold* I am just bold.**

***I'm bold and italic!** I am just italic.*

BetterEm will try to prioritize the more sane option when nesting bold (**) between italic (*).

*I'm italic. **I'm bold and italic.** I'm also just italic.*

BetterEm will ensure smart mode doesn't terminate in scenarios where there are a large amount of consecutive tokens inside.

___A lot of underscores____________is okay___

BetterEm will also ensure that smart mode breaks properly when an inner like token signifies an end.

__This will all be bold __because of the placement of the center underscores.__

__This will all be bold __ because of the placement of the center underscores.__

__This will NOT all be bold__ because of the placement of the center underscores.__

__This will all be bold_ because of the token is less than that of the surrounding.__

BetterEm will allow non-smart emphasis to contain "floating" like tokens.

*All will * be italic*

*All will *be italic*

*All will not* be italic*

*All will not ** be italic*

**All will * be bold**

**All will *be bold**

**All will not*** be bold**

**All will not *** be bold**

Options