From 29a4e551f772fb83f2c22d166bdce2ab24485de0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20van=20Delft?= Date: Mon, 15 Feb 2021 16:37:13 +0100 Subject: [PATCH] Update README with the two new options --- README.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.rst b/README.rst index 4d21411..0988ef1 100644 --- a/README.rst +++ b/README.rst @@ -75,6 +75,12 @@ bullets lists are nested. Otherwise, the bullet will alternate based on nesting level. Defaults to ``'*+-'``. +strong_em_symbol + In markdown, both `*` and `_` are used to encode **strong** or *emphasized* texts. The preferred symbol can be passed through this argument, which defaults to `*`. + +newline + Defines the style of marking linebreaks (`
`) in markdown. The default value `'spaces'` of this option means the regular ' \n' will be used (i.e. two spaces and a newline), while `'backslash'` will convert a linebreak to `''\\\n'` (a backslash an a newline). While the latter convention is non-standard, it is commonly preferred and supported by a lot of converters. + Options may be specified as kwargs to the ``markdownify`` function, or as a nested ``Options`` class in ``MarkdownConverter`` subclasses.