diff --git a/README.rst b/README.rst index b8453ca..4e93b92 100644 --- a/README.rst +++ b/README.rst @@ -29,6 +29,38 @@ Specify tags to exclude (blacklist): md('Yay GitHub', convert=['b']) # > '**Yay** GitHub' +Options +======= + +Markdownify supports the following options: + +strip + A list of tags to strip (blacklist). This option can't be used with the + ``convert`` option. + +convert + A list of tags to convert (whitelist). This option can't be used with the + ``strip`` option. + +autolinks + A boolean indicating whether the "automatic link" style should be used when + a ``a`` tag's contents match its href. Defaults to ``True`` + +heading_style + Defines how headings should be converted. Accepted values are ``ATX``, + ``ATX_CLOSED``, ``SETEXT``, and ``UNDERLINED`` (which is an alias for + ``SETEXT``). Defaults to ``UNDERLINED``. + +bullets + An iterable (string, list, or tuple) of bullet styles to be used. If the + iterable only contains one item, it will be used regardless of how deeply + lists are nested. Otherwise, the bullet will alternate based on nesting + level. Defaults to ``'*+-'``. + +Options may be specified as kwargs to the ``markdownify`` function, or as a +nested ``Options`` class in ``MarkdownConverter`` subclasses. + + Development ===========